all: autogenerated update (2017-12-17)
Update:
- bigquerydatatransfer/v1
- container/v1
- container/v1beta1
diff --git a/abusiveexperiencereport/v1/abusiveexperiencereport-api.json b/abusiveexperiencereport/v1/abusiveexperiencereport-api.json
index 9a8151e..afeb204 100644
--- a/abusiveexperiencereport/v1/abusiveexperiencereport-api.json
+++ b/abusiveexperiencereport/v1/abusiveexperiencereport-api.json
@@ -1,108 +1,4 @@
{
- "kind": "discovery#restDescription",
- "description": "View Abusive Experience Report data, and get a list of sites that have a significant number of abusive experiences.",
- "servicePath": "",
- "basePath": "",
- "id": "abusiveexperiencereport:v1",
- "documentationLink": "https://developers.google.com/abusive-experience-report/",
- "revision": "20171129",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "SiteSummaryResponse": {
- "description": "Response message for GetSiteSummary.",
- "type": "object",
- "properties": {
- "abusiveStatus": {
- "enum": [
- "UNKNOWN",
- "PASSING",
- "FAILING"
- ],
- "description": "The status of the site reviewed for the abusive experiences.",
- "type": "string",
- "enumDescriptions": [
- "Not reviewed.",
- "Passing.",
- "Failing."
- ]
- },
- "enforcementTime": {
- "description": "The date on which enforcement begins.",
- "format": "google-datetime",
- "type": "string"
- },
- "filterStatus": {
- "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"
- ],
- "description": "The abusive experience enforcement status of the site."
- },
- "underReview": {
- "type": "boolean",
- "description": "Whether the site is currently under review."
- },
- "reportUrl": {
- "description": "A link that leads to a full abusive experience report.",
- "type": "string"
- },
- "lastChangeTime": {
- "description": "The last time that the site changed status.",
- "format": "google-datetime",
- "type": "string"
- },
- "reviewedSite": {
- "description": "The name of the site reviewed.",
- "type": "string"
- }
- },
- "id": "SiteSummaryResponse"
- },
- "ViolatingSitesResponse": {
- "description": "Response message for ListViolatingSites.",
- "type": "object",
- "properties": {
- "violatingSites": {
- "description": "A list of summaries of violating sites.",
- "type": "array",
- "items": {
- "$ref": "SiteSummaryResponse"
- }
- }
- },
- "id": "ViolatingSitesResponse"
- }
- },
- "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": "Abusive Experience Report",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/xapi.zoo": {
- "description": "Test scope for access to the Zoo service"
- }
- }
- }
- },
- "rootUrl": "https://abusiveexperiencereport.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "abusiveexperiencereport",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Abusive Experience Report API",
@@ -111,25 +7,29 @@
"violatingSites": {
"methods": {
"list": {
- "description": "Lists sites with Abusive Experience Report statuses of \"Failing\".",
- "httpMethod": "GET",
- "parameterOrder": [],
"response": {
"$ref": "ViolatingSitesResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/xapi.zoo"
],
"flatPath": "v1/violatingSites",
+ "path": "v1/violatingSites",
"id": "abusiveexperiencereport.violatingSites.list",
- "path": "v1/violatingSites"
+ "description": "Lists sites with Abusive Experience Report statuses of \"Failing\"."
}
}
},
"sites": {
"methods": {
"get": {
+ "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"
},
@@ -137,48 +37,23 @@
"name"
],
"httpMethod": "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."
+ "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"
+ }
+ }
}
}
}
},
"parameters": {
- "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": {
- "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",
@@ -189,6 +64,11 @@
"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",
@@ -202,49 +82,169 @@
"2"
]
},
- "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"
- ]
+ ],
+ "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": {
- "description": "OAuth access 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": {
"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"
}
},
"version": "v1",
- "baseUrl": "https://abusiveexperiencereport.googleapis.com/"
+ "baseUrl": "https://abusiveexperiencereport.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "View Abusive Experience Report data, and get a list of sites that have a significant number of abusive experiences.",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20171129",
+ "documentationLink": "https://developers.google.com/abusive-experience-report/",
+ "id": "abusiveexperiencereport:v1",
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "schemas": {
+ "ViolatingSitesResponse": {
+ "description": "Response message for ListViolatingSites.",
+ "type": "object",
+ "properties": {
+ "violatingSites": {
+ "description": "A list of summaries of violating sites.",
+ "type": "array",
+ "items": {
+ "$ref": "SiteSummaryResponse"
+ }
+ }
+ },
+ "id": "ViolatingSitesResponse"
+ },
+ "SiteSummaryResponse": {
+ "description": "Response message for GetSiteSummary.",
+ "type": "object",
+ "properties": {
+ "lastChangeTime": {
+ "description": "The last time that the site changed status.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "reviewedSite": {
+ "description": "The name of the site reviewed.",
+ "type": "string"
+ },
+ "abusiveStatus": {
+ "enumDescriptions": [
+ "Not reviewed.",
+ "Passing.",
+ "Failing."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "PASSING",
+ "FAILING"
+ ],
+ "description": "The status of the site reviewed for the abusive experiences.",
+ "type": "string"
+ },
+ "enforcementTime": {
+ "description": "The date on which enforcement begins.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "filterStatus": {
+ "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"
+ ],
+ "description": "The abusive experience enforcement status of the site.",
+ "type": "string"
+ },
+ "underReview": {
+ "description": "Whether the site is currently under review.",
+ "type": "boolean"
+ },
+ "reportUrl": {
+ "description": "A link that leads to a full abusive experience report.",
+ "type": "string"
+ }
+ },
+ "id": "SiteSummaryResponse"
+ }
+ },
+ "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": "Abusive Experience Report",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/xapi.zoo": {
+ "description": "Test scope for access to the Zoo service"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://abusiveexperiencereport.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "abusiveexperiencereport"
}
diff --git a/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json b/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
index 4dd3527..c307975 100644
--- a/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
+++ b/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
@@ -1,11 +1,16 @@
{
+ "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": "",
+ "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "acceleratedmobilepageurl",
"batchPath": "batch",
"revision": "20171202",
- "id": "acceleratedmobilepageurl:v1",
"documentationLink": "https://developers.google.com/amp/cache/",
+ "id": "acceleratedmobilepageurl:v1",
"title": "Accelerated Mobile Pages (AMP) URL API",
"discoveryVersion": "v1",
"ownerName": "Google",
@@ -14,6 +19,10 @@
"ampUrls": {
"methods": {
"batchGet": {
+ "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": {
@@ -22,11 +31,7 @@
"parameters": {},
"flatPath": "v1/ampUrls:batchGet",
"id": "acceleratedmobilepageurl.ampUrls.batchGet",
- "path": "v1/ampUrls:batchGet",
- "request": {
- "$ref": "BatchGetAmpUrlsRequest"
- },
- "description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format)."
+ "path": "v1/ampUrls:batchGet"
}
}
}
@@ -48,15 +53,15 @@
"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",
- "location": "query"
+ "type": "string"
},
"uploadType": {
"location": "query",
@@ -64,26 +69,24 @@
"type": "string"
},
"$.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",
- "location": "query"
+ "type": "string"
},
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -95,7 +98,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": {
"location": "query",
@@ -108,18 +113,79 @@
"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"
+ "default": "true",
+ "location": "query"
}
},
"schemas": {
+ "AmpUrlError": {
+ "description": "AMP URL Error resource for a requested URL that couldn't be found.",
+ "type": "object",
+ "properties": {
+ "errorMessage": {
+ "description": "An optional descriptive error message.",
+ "type": "string"
+ },
+ "errorCode": {
+ "enumDescriptions": [
+ "Not specified error.",
+ "Indicates the requested URL is not found in the index, possibly because\nit's unable to be found, not able to be accessed by Googlebot, or some\nother error.",
+ "Indicates no AMP URL has been found that corresponds to the requested\nURL.",
+ "Indicates some kind of application error occurred at the server.\nClient advised to retry.",
+ "DEPRECATED: Indicates the requested URL is a valid AMP URL. This is a\nnon-error state, should not be relied upon as a sign of success or\nfailure. It will be removed in future versions of the API.",
+ "Indicates that an AMP URL has been found that corresponds to the request\nURL, but it is not valid AMP HTML."
+ ],
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "INPUT_URL_NOT_FOUND",
+ "NO_AMP_URL",
+ "APPLICATION_ERROR",
+ "URL_IS_VALID_AMP",
+ "URL_IS_INVALID_AMP"
+ ],
+ "description": "The error code of an API call.",
+ "type": "string"
+ },
+ "originalUrl": {
+ "description": "The original non-AMP URL.",
+ "type": "string"
+ }
+ },
+ "id": "AmpUrlError"
+ },
+ "BatchGetAmpUrlsRequest": {
+ "description": "AMP URL request for a batch of URLs.",
+ "type": "object",
+ "properties": {
+ "lookupStrategy": {
+ "description": "The lookup_strategy being requested.",
+ "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"
+ ]
+ },
+ "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": {
"description": "Batch AMP URL response.",
"type": "object",
@@ -142,6 +208,7 @@
"id": "BatchGetAmpUrlsResponse"
},
"AmpUrl": {
+ "description": "AMP URL response for a requested URL.",
"type": "object",
"properties": {
"cdnAmpUrl": {
@@ -153,84 +220,17 @@
"type": "string"
},
"ampUrl": {
- "type": "string",
- "description": "The AMP URL pointing to the publisher's web server."
+ "description": "The AMP URL pointing to the publisher's web server.",
+ "type": "string"
}
},
- "id": "AmpUrl",
- "description": "AMP URL response for a requested URL."
- },
- "AmpUrlError": {
- "id": "AmpUrlError",
- "description": "AMP URL Error resource for a requested URL that couldn't be found.",
- "type": "object",
- "properties": {
- "originalUrl": {
- "type": "string",
- "description": "The original non-AMP URL."
- },
- "errorMessage": {
- "description": "An optional descriptive error message.",
- "type": "string"
- },
- "errorCode": {
- "description": "The error code of an API call.",
- "type": "string",
- "enumDescriptions": [
- "Not specified error.",
- "Indicates the requested URL is not found in the index, possibly because\nit's unable to be found, not able to be accessed by Googlebot, or some\nother error.",
- "Indicates no AMP URL has been found that corresponds to the requested\nURL.",
- "Indicates some kind of application error occurred at the server.\nClient advised to retry.",
- "DEPRECATED: Indicates the requested URL is a valid AMP URL. This is a\nnon-error state, should not be relied upon as a sign of success or\nfailure. It will be removed in future versions of the API.",
- "Indicates that an AMP URL has been found that corresponds to the request\nURL, but it is not valid AMP HTML."
- ],
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "INPUT_URL_NOT_FOUND",
- "NO_AMP_URL",
- "APPLICATION_ERROR",
- "URL_IS_VALID_AMP",
- "URL_IS_INVALID_AMP"
- ]
- }
- }
- },
- "BatchGetAmpUrlsRequest": {
- "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",
- "description": "AMP URL request for a batch of URLs.",
- "type": "object"
+ "id": "AmpUrl"
}
},
- "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"
},
- "version": "v1",
- "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": "",
- "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/"
+ "protocol": "rest",
+ "version": "v1"
}
diff --git a/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json b/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
index c7c5e6b..ff35279 100644
--- a/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
+++ b/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
@@ -1,50 +1,1256 @@
{
- "revision": "20171214",
- "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/reference/rest/",
- "id": "adexchangebuyer2:v2beta1",
- "discoveryVersion": "v1",
- "version_module": true,
"schemas": {
- "ListDealAssociationsResponse": {
- "description": "A response for listing creative and deal associations",
+ "AuctionContext": {
+ "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": {
+ "enum": [
+ "OPEN_AUCTION",
+ "DIRECT_DEALS"
+ ],
+ "type": "string"
+ }
+ }
+ },
+ "id": "AuctionContext",
+ "description": "@OutputOnly The auction type the restriction applies to.",
+ "type": "object"
+ },
+ "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"
+ }
+ }
+ },
+ "id": "ListImpressionMetricsResponse"
+ },
+ "BidMetricsRow": {
+ "properties": {
+ "measurableImpressions": {
+ "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View).",
+ "$ref": "MetricValue"
+ },
+ "bids": {
+ "description": "The number of bids that Ad Exchange received from the buyer.",
+ "$ref": "MetricValue"
+ },
+ "billedImpressions": {
+ "description": "The number of bids for which the buyer was billed.",
+ "$ref": "MetricValue"
+ },
+ "bidsInAuction": {
+ "description": "The number of bids that were permitted to compete in the auction.",
+ "$ref": "MetricValue"
+ },
+ "rowDimensions": {
+ "description": "The values of all dimensions associated with metric values in this row.",
+ "$ref": "RowDimensions"
+ },
+ "viewableImpressions": {
+ "$ref": "MetricValue",
+ "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View)."
+ },
+ "impressionsWon": {
+ "description": "The number of bids that won an impression.",
+ "$ref": "MetricValue"
+ }
+ },
+ "id": "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"
+ },
+ "ListBidResponseErrorsResponse": {
+ "properties": {
+ "calloutStatusRows": {
+ "description": "List of rows, with counts of bid responses aggregated by callout status.",
+ "type": "array",
+ "items": {
+ "$ref": "CalloutStatusRow"
+ }
+ },
+ "nextPageToken": {
+ "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",
+ "description": "Response message for listing all reasons that bid responses resulted in an\nerror.",
+ "type": "object"
+ },
+ "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": {
+ "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": {
+ "properties": {
+ "startTimestamp": {
+ "description": "The start timestamp of the real-time RTB metrics aggregation.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "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": {
+ "properties": {
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
+ },
+ "bidCount": {
+ "$ref": "MetricValue",
+ "description": "The number of bids with the specified status."
+ },
+ "status": {
+ "enumDescriptions": [
+ "A placeholder for an undefined status.\nThis value will never be returned in responses.",
+ "The buyer was not billed because the ad was not rendered by the\npublisher.",
+ "The buyer was not billed because the impression won by the bid was\ndetermined to be invalid."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "AD_NOT_RENDERED",
+ "INVALID_IMPRESSION"
+ ],
+ "description": "The status specifying why the winning bids were not billed.",
+ "type": "string"
+ }
+ },
+ "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.",
+ "type": "object"
+ },
+ "FilteredBidDetailRow": {
+ "properties": {
+ "rowDimensions": {
+ "$ref": "RowDimensions",
+ "description": "The values of all dimensions associated with metric values in this row."
+ },
+ "bidCount": {
+ "$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"
+ }
+ },
+ "id": "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"
+ },
+ "AbsoluteDateRange": {
+ "properties": {
+ "startDate": {
+ "$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": {
+ "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",
+ "description": "An absolute date range, specified by its start date and end date.\nThe supported range of dates begins 30 days before today and ends today.\nValidity checked upon filter set creation. If a filter set with an absolute\ndate range is run at a later date more than 30 days after start_date, it will\nfail.",
+ "type": "object"
+ },
+ "AddDealAssociationRequest": {
+ "description": "A request for associating a deal and a creative.",
+ "type": "object",
+ "properties": {
+ "association": {
+ "$ref": "CreativeDealAssociation",
+ "description": "The association between a creative and a deal that should be added."
+ }
+ },
+ "id": "AddDealAssociationRequest"
+ },
+ "WatchCreativeRequest": {
+ "properties": {
+ "topic": {
+ "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",
+ "description": "A request for watching changes to creative Status.",
+ "type": "object"
+ },
+ "TimeInterval": {
+ "properties": {
+ "endTime": {
+ "description": "The timestamp marking the end of the range (exclusive) 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.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "TimeInterval",
+ "description": "An interval of time, with an absolute start and end.",
+ "type": "object"
+ },
+ "FilteredBidCreativeRow": {
+ "properties": {
+ "rowDimensions": {
+ "description": "The values of all dimensions associated with metric values in this row.",
+ "$ref": "RowDimensions"
+ },
+ "bidCount": {
+ "description": "The number of bids with the specified creative.",
+ "$ref": "MetricValue"
+ },
+ "creativeId": {
+ "description": "The ID of the creative.",
+ "type": "string"
+ }
+ },
+ "id": "FilteredBidCreativeRow",
+ "description": "The number of filtered bids with the specified dimension values that have the\nspecified creative.",
+ "type": "object"
+ },
+ "RelativeDateRange": {
+ "properties": {
+ "durationDays": {
+ "description": "The number of days in the requested date range. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "offsetDays": {
+ "description": "The end date of the filter set, specified as the number of days before\ntoday. E.g. for a range where the last date is today, 0.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "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",
+ "type": "object"
+ },
+ "ListClientsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list method\nto retrieve the next page of results.",
+ "type": "string"
+ },
+ "clients": {
+ "description": "The returned list of clients.",
+ "type": "array",
+ "items": {
+ "$ref": "Client"
+ }
+ }
+ },
+ "id": "ListClientsResponse",
+ "type": "object"
+ },
+ "NativeContent": {
+ "properties": {
+ "image": {
+ "$ref": "Image",
+ "description": "A large image."
+ },
+ "clickTrackingUrl": {
+ "description": "The URL to use for click tracking.",
+ "type": "string"
+ },
+ "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."
+ },
+ "callToAction": {
+ "description": "A label for the button that the user is supposed to click.",
+ "type": "string"
+ },
+ "body": {
+ "description": "A long description of the ad.",
+ "type": "string"
+ },
+ "starRating": {
+ "description": "The app rating in the app store. Must be in the range [0-5].",
+ "format": "double",
+ "type": "number"
+ },
+ "videoUrl": {
+ "description": "The URL to fetch a native video ad.",
+ "type": "string"
+ },
+ "clickLinkUrl": {
+ "description": "The URL that the browser/SDK will load when the user clicks the ad.",
+ "type": "string"
+ },
+ "logo": {
+ "$ref": "Image",
+ "description": "A smaller image, for the advertiser's logo."
+ },
+ "priceDisplayText": {
+ "description": "The price of the promoted app including currency info.",
+ "type": "string"
+ }
+ },
+ "id": "NativeContent",
+ "description": "Native content for a creative.",
+ "type": "object"
+ },
+ "ListBidResponsesWithoutBidsResponse": {
+ "description": "Response message for listing all reasons that bid responses were considered\nto have no applicable bids.",
+ "type": "object",
+ "properties": {
+ "bidResponseWithoutBidsStatusRows": {
+ "description": "List of rows, with counts of bid responses without bids aggregated by\nstatus.",
+ "type": "array",
+ "items": {
+ "$ref": "BidResponseWithoutBidsStatusRow"
+ }
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponsesWithoutBidsRequest.pageToken\nfield in the subsequent call to the bidResponsesWithoutBids.list\nmethod to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListBidResponsesWithoutBidsResponse"
+ },
+ "ServingContext": {
+ "properties": {
+ "auctionType": {
+ "description": "Matches impressions for a particular auction type.",
+ "$ref": "AuctionContext"
+ },
+ "all": {
+ "enumDescriptions": [
+ "A simple context."
+ ],
+ "enum": [
+ "SIMPLE_CONTEXT"
+ ],
+ "description": "Matches all contexts.",
+ "type": "string"
+ },
+ "appType": {
+ "description": "Matches impressions for a particular app type.",
+ "$ref": "AppContext"
+ },
+ "securityType": {
+ "$ref": "SecurityContext",
+ "description": "Matches impressions for a particular security type."
+ },
+ "platform": {
+ "$ref": "PlatformContext",
+ "description": "Matches impressions coming from a particular platform."
+ },
+ "location": {
+ "$ref": "LocationContext",
+ "description": "Matches impressions coming from users *or* publishers in a specific\nlocation."
+ }
+ },
+ "id": "ServingContext",
+ "description": "The serving context for this restriction.",
+ "type": "object"
+ },
+ "Image": {
+ "properties": {
+ "height": {
+ "description": "Image height in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "width": {
+ "description": "Image width in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "description": "The URL of the image.",
+ "type": "string"
+ }
+ },
+ "id": "Image",
+ "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.",
+ "type": "object"
+ },
+ "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": {
+ "properties": {
+ "rowDimensions": {
+ "description": "The values of all dimensions associated with metric values in this row.",
+ "$ref": "RowDimensions"
+ },
+ "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"
+ }
+ },
+ "id": "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"
+ },
+ "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": {
+ "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"
+ },
+ "ListCreativeStatusBreakdownByDetailResponse": {
+ "properties": {
+ "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"
+ },
+ "detailType": {
+ "enum": [
+ "DETAIL_TYPE_UNSPECIFIED",
+ "CREATIVE_ATTRIBUTE",
+ "VENDOR",
+ "SENSITIVE_CATEGORY",
+ "PRODUCT_CATEGORY",
+ "DISAPPROVAL_REASON"
+ ],
+ "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)."
+ ]
+ }
+ },
+ "id": "ListCreativeStatusBreakdownByDetailResponse",
+ "description": "Response message for listing all details associated with a given filtered bid\nreason.",
+ "type": "object"
+ },
+ "ListClientUsersResponse": {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "users": {
+ "description": "The returned list of client users.",
+ "type": "array",
+ "items": {
+ "$ref": "ClientUser"
+ }
+ }
+ },
+ "id": "ListClientUsersResponse"
+ },
+ "ListClientUserInvitationsResponse": {
+ "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",
+ "type": "object"
+ },
+ "LocationContext": {
+ "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",
+ "description": "@OutputOnly The Geo criteria the restriction applies to.",
+ "type": "object"
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "ClientUser"
+ },
+ "CreativeDealAssociation": {
+ "properties": {
+ "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"
+ },
+ "accountId": {
+ "description": "The account the creative belongs to.",
+ "type": "string"
+ }
+ },
+ "id": "CreativeDealAssociation",
+ "description": "The association between a creative and a deal.",
+ "type": "object"
+ },
+ "FilteringStats": {
+ "description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "reasons": {
+ "description": "The set of filtering reasons for this date.",
+ "type": "array",
+ "items": {
+ "$ref": "Reason"
+ }
+ }
+ },
+ "id": "FilteringStats"
+ },
+ "Creative": {
+ "description": "A creative and its classification data.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "$ref": "VideoContent",
+ "description": "A video creative."
+ },
+ "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": {
+ "description": "An HTML creative.",
+ "$ref": "HtmlContent"
+ },
+ "dealsStatus": {
+ "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",
+ "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."
+ ]
+ },
+ "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": {
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "NOT_CHECKED",
+ "CONDITIONALLY_APPROVED",
+ "APPROVED",
+ "DISAPPROVED"
+ ],
+ "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."
+ ]
+ },
+ "advertiserName": {
+ "description": "The name of the company being advertised in the creative.",
+ "type": "string"
+ },
+ "detectedDomains": {
+ "description": "@OutputOnly\nThe detected domains for this creative.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "detectedAdvertiserIds": {
+ "description": "@OutputOnly Detected advertiser IDs, if any.",
+ "type": "array",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "filteringStats": {
+ "description": "@OutputOnly The filtering stats for this creative.",
+ "$ref": "FilteringStats"
+ },
+ "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"
+ }
+ },
+ "id": "Creative"
+ },
+ "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"
+ }
+ },
+ "id": "RemoveDealAssociationRequest"
+ },
+ "ListCreativeStatusBreakdownByCreativeResponse": {
+ "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",
+ "description": "Response message for listing all creatives associated with a given filtered\nbid reason.",
+ "type": "object"
+ },
+ "Client": {
+ "properties": {
+ "partnerClientId": {
+ "description": "Optional arbitrary unique identifier of this client buyer from the\nstandpoint of its Ad Exchange sponsor buyer.\n\nThis field can be used to associate a client buyer with the identifier\nin the namespace of its sponsor buyer, lookup client buyers by that\nidentifier and verify whether an Ad Exchange counterpart of a given client\nbuyer already exists.\n\nIf present, must be unique among all the client buyers for its\nAd Exchange sponsor buyer.",
+ "type": "string"
+ },
+ "entityType": {
+ "enumDescriptions": [
+ "A placeholder for an undefined client entity type. Should not be used.",
+ "An advertiser.",
+ "A brand.",
+ "An advertising agency."
+ ],
+ "enum": [
+ "ENTITY_TYPE_UNSPECIFIED",
+ "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": {
+ "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.",
+ "Users associated with this client can respond to deal proposals\nsent to them by publishers. They can also initiate deal proposals\nof their own.",
+ "Users associated with this client can approve eligible deals\non your behalf. Some deals may still explicitly require publisher\nfinalization. If this role is not selected, the sponsor buyer\nwill need to manually approve each of their deals."
+ ],
+ "enum": [
+ "CLIENT_ROLE_UNSPECIFIED",
+ "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.",
+ "type": "boolean"
+ },
+ "entityId": {
+ "description": "Numerical identifier of the client entity.\nThe entity can be an advertiser, a brand, or an agency.\nThis identifier is unique among all the entities with the same type.\n\nA list of all known advertisers with their identifiers is available in the\n[advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all known brands with their identifiers is available in the\n[brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known agencies with their identifiers is available in the\n[agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.",
+ "format": "int64",
+ "type": "string"
+ },
+ "clientAccountId": {
+ "description": "The globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations.",
+ "format": "int64",
+ "type": "string"
+ },
+ "entityName": {
+ "description": "The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations.",
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "CLIENT_STATUS_UNSPECIFIED",
+ "DISABLED",
+ "ACTIVE"
+ ],
+ "description": "The status of the client buyer.",
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined client status.",
+ "A client that is currently disabled.",
+ "A client that is currently active."
+ ]
+ }
+ },
+ "id": "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"
+ },
+ "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",
+ "SSL_ATTRIBUTE_REMOVED",
+ "FLASH_FREE_ATTRIBUTE_REMOVED",
+ "FLASH_FREE_ATTRIBUTE_ADDED",
+ "REQUIRED_ATTRIBUTE_ADDED",
+ "REQUIRED_VENDOR_ADDED",
+ "SSL_ATTRIBUTE_ADDED",
+ "IN_BANNER_VIDEO_ATTRIBUTE_ADDED",
+ "MRAID_ATTRIBUTE_ADDED",
+ "FLASH_ATTRIBUTE_REMOVED",
+ "VIDEO_IN_SNIPPET_ATTRIBUTE_ADDED"
+ ],
+ "description": "The type of correction that was applied to the creative.",
+ "type": "string"
+ },
+ "contexts": {
+ "description": "The contexts for the correction.",
+ "type": "array",
+ "items": {
+ "$ref": "ServingContext"
+ }
+ }
+ },
+ "id": "Correction"
+ },
+ "FilterSet": {
+ "properties": {
+ "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": {
+ "enum": [
+ "FORMAT_UNSPECIFIED",
+ "DISPLAY",
+ "VIDEO"
+ ],
+ "type": "string"
+ }
+ },
+ "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": {
+ "enum": [
+ "PLATFORM_UNSPECIFIED",
+ "DESKTOP",
+ "TABLET",
+ "MOBILE"
+ ],
+ "type": "string"
+ }
+ },
+ "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.",
+ "type": "string"
+ },
+ "sellerNetworkIds": {
+ "description": "The list of IDs of the seller (publisher) networks on which to filter;\nmay be empty. The filters represented by multiple seller network IDs are\nORed together (i.e. if non-empty, results must match any one of the\npublisher networks).\nSee [seller-network-ids](https://developers.google.com/ad-exchange/rtb/downloads/seller-network-ids)\nfile for the set of existing seller network IDs.",
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "absoluteDateRange": {
+ "description": "An absolute date range, defined by a start date and an end date.\nInterpreted relative to Pacific time zone.",
+ "$ref": "AbsoluteDateRange"
+ },
+ "environment": {
+ "enum": [
+ "ENVIRONMENT_UNSPECIFIED",
+ "WEB",
+ "APP"
+ ],
+ "description": "The environment on which to filter; optional.",
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined environment; indicates that no environment\nfilter will be applied.",
+ "The ad impression appears on the web.",
+ "The ad impression appears in an app."
+ ]
+ },
+ "format": {
+ "enum": [
+ "FORMAT_UNSPECIFIED",
+ "DISPLAY",
+ "VIDEO"
+ ],
+ "description": "DEPRECATED: use repeated formats field instead.\nThe format on which to filter; optional.",
+ "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."
+ ]
+ },
+ "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"
+ },
+ "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": {
+ "description": "An open-ended realtime time range, defined by the aggregation start\ntimestamp.",
+ "$ref": "RealtimeTimeRange"
+ }
+ },
+ "id": "FilterSet",
+ "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"
+ },
+ "CalloutStatusRow": {
+ "properties": {
+ "impressionCount": {
+ "$ref": "MetricValue",
+ "description": "The number of impressions for which there was a bid request or bid response\nwith the specified callout status."
+ },
+ "rowDimensions": {
+ "description": "The values of all dimensions associated with metric values in this row.",
+ "$ref": "RowDimensions"
+ },
+ "calloutStatusId": {
+ "description": "The ID of the callout status.\nSee [callout-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-status-codes).",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "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.",
+ "type": "object"
+ },
+ "ListDealAssociationsResponse": {
+ "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.",
+ "type": "string"
+ },
"associations": {
"description": "The list of associations.",
"type": "array",
"items": {
"$ref": "CreativeDealAssociation"
}
- },
- "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.",
- "type": "string"
}
},
- "id": "ListDealAssociationsResponse"
+ "id": "ListDealAssociationsResponse",
+ "description": "A response for listing creative and deal associations",
+ "type": "object"
},
- "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.",
- "type": "object",
- "properties": {
- "calloutStatusId": {
- "description": "The ID of the callout status.\nSee [callout-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-status-codes).",
- "format": "int32",
- "type": "integer"
- },
- "impressionCount": {
- "description": "The number of impressions for which there was a bid request or bid response\nwith the specified callout status.",
- "$ref": "MetricValue"
- },
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- }
- },
- "id": "CalloutStatusRow"
+ "StopWatchingCreativeRequest": {
+ "properties": {},
+ "id": "StopWatchingCreativeRequest",
+ "description": "A request for stopping notifications for changes to creative Status.",
+ "type": "object"
},
"Disapproval": {
- "id": "Disapproval",
"description": "@OutputOnly The reason and details for a disapproval.",
"type": "object",
"properties": {
@@ -251,17 +1457,10 @@
"description": "The categorized reason for disapproval.",
"type": "string"
}
- }
- },
- "StopWatchingCreativeRequest": {
- "description": "A request for stopping notifications for changes to creative Status.",
- "type": "object",
- "properties": {},
- "id": "StopWatchingCreativeRequest"
+ },
+ "id": "Disapproval"
},
"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": {
"contexts": {
"description": "The contexts for the restriction.",
@@ -271,18 +1470,18 @@
}
},
"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",
- "enumDescriptions": [
- "The status is not known.",
- "The ad was disapproved in this context.",
- "The ad is pending review in this context."
- ]
+ "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.",
@@ -292,9 +1491,13 @@
}
}
},
- "id": "ServingRestriction"
+ "id": "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"
},
"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.",
@@ -312,12 +1515,9 @@
"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"
+ "id": "Date"
},
"RowDimensions": {
- "type": "object",
"properties": {
"timeInterval": {
"$ref": "TimeInterval",
@@ -325,7 +1525,8 @@
}
},
"id": "RowDimensions",
- "description": "A response may include multiple rows, breaking down along various dimensions.\nEncapsulates the values of all dimensions for a given row."
+ "description": "A response may include multiple rows, breaking down along various dimensions.\nEncapsulates the values of all dimensions for a given row.",
+ "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 `{}`.",
@@ -334,6 +1535,7 @@
"id": "Empty"
},
"AppContext": {
+ "description": "@OutputOnly The app type the restriction applies to for mobile device.",
"type": "object",
"properties": {
"appTypes": {
@@ -352,8 +1554,7 @@
]
}
},
- "id": "AppContext",
- "description": "@OutputOnly The app type the restriction applies to for mobile device."
+ "id": "AppContext"
},
"ListFilteredBidsResponse": {
"description": "Response message for listing all reasons that bids were filtered from the\nauction.",
@@ -376,46 +1577,25 @@
"SecurityContext": {
"properties": {
"securities": {
- "description": "The security types in this context.",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "INSECURE",
- "SSL"
- ]
- },
"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",
"description": "@OutputOnly A security context.",
"type": "object"
},
- "HtmlContent": {
- "description": "HTML content for a creative.",
- "type": "object",
- "properties": {
- "width": {
- "description": "The width of the HTML snippet in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "snippet": {
- "description": "The HTML snippet that displays the ad when inserted in the web page.",
- "type": "string"
- },
- "height": {
- "description": "The height of the HTML snippet in pixels.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "HtmlContent"
- },
"ListCreativesResponse": {
"description": "A response for listing creatives.",
"type": "object",
@@ -434,50 +1614,71 @@
},
"id": "ListCreativesResponse"
},
- "ListFilteredBidRequestsResponse": {
- "id": "ListFilteredBidRequestsResponse",
- "description": "Response message for listing all reasons that bid requests were filtered and\nnot sent to the buyer.",
- "type": "object",
+ "HtmlContent": {
"properties": {
- "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"
+ "height": {
+ "description": "The height of the HTML snippet in pixels.",
+ "format": "int32",
+ "type": "integer"
},
+ "width": {
+ "description": "The width of the HTML snippet in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "snippet": {
+ "description": "The HTML snippet that displays the ad when inserted in the web page.",
+ "type": "string"
+ }
+ },
+ "id": "HtmlContent",
+ "description": "HTML content for a creative.",
+ "type": "object"
+ },
+ "ListFilteredBidRequestsResponse": {
+ "properties": {
"calloutStatusRows": {
"description": "List of rows, with counts of filtered bid requests aggregated by callout\nstatus.",
"type": "array",
"items": {
"$ref": "CalloutStatusRow"
}
- }
- }
- },
- "ListBidMetricsResponse": {
- "description": "Response message for listing the metrics that are measured in number of bids.",
- "type": "object",
- "properties": {
- "bidMetricsRows": {
- "type": "array",
- "items": {
- "$ref": "BidMetricsRow"
- },
- "description": "List of rows, each containing a set of bid metrics."
},
"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.",
+ "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"
}
},
- "id": "ListBidMetricsResponse"
+ "id": "ListFilteredBidRequestsResponse",
+ "description": "Response message for listing all reasons that bid requests were filtered and\nnot sent to the buyer.",
+ "type": "object"
+ },
+ "ListBidMetricsResponse": {
+ "properties": {
+ "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"
+ },
+ "bidMetricsRows": {
+ "description": "List of rows, each containing a set of bid metrics.",
+ "type": "array",
+ "items": {
+ "$ref": "BidMetricsRow"
+ }
+ }
+ },
+ "id": "ListBidMetricsResponse",
+ "description": "Response message for listing the metrics that are measured in number of bids.",
+ "type": "object"
},
"Reason": {
"description": "A specific filtering status and how many times it occurred.",
"type": "object",
"properties": {
"count": {
- "type": "string",
"description": "The number of times the creative was filtered for the status. The\ncount is aggregated across all publishers on the exchange.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"status": {
"description": "The filtering status code. Please refer to the\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)\nfile for different statuses.",
@@ -487,37 +1688,7 @@
},
"id": "Reason"
},
- "VideoContent": {
- "description": "Video content for a creative.",
- "type": "object",
- "properties": {
- "videoUrl": {
- "description": "The URL to fetch a video ad.",
- "type": "string"
- }
- },
- "id": "VideoContent"
- },
- "ListLosingBidsResponse": {
- "properties": {
- "creativeStatusRows": {
- "description": "List of rows, with counts of losing bids aggregated by loss reason (i.e.\ncreative status).",
- "type": "array",
- "items": {
- "$ref": "CreativeStatusRow"
- }
- },
- "nextPageToken": {
- "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",
- "description": "Response message for listing all reasons that bids lost in the auction.",
- "type": "object"
- },
"ListNonBillableWinningBidsResponse": {
- "id": "ListNonBillableWinningBidsResponse",
"description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid.",
"type": "object",
"properties": {
@@ -532,11 +1703,39 @@
"description": "A token to retrieve the next page of results.\nPass this value in the\nListNonBillableWinningBidsRequest.pageToken\nfield in the subsequent call to the nonBillableWinningBids.list\nmethod to retrieve the next page of results.",
"type": "string"
}
- }
+ },
+ "id": "ListNonBillableWinningBidsResponse"
+ },
+ "ListLosingBidsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "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"
+ },
+ "creativeStatusRows": {
+ "description": "List of rows, with counts of losing bids aggregated by loss reason (i.e.\ncreative status).",
+ "type": "array",
+ "items": {
+ "$ref": "CreativeStatusRow"
+ }
+ }
+ },
+ "id": "ListLosingBidsResponse",
+ "description": "Response message for listing all reasons that bids lost in the auction.",
+ "type": "object"
+ },
+ "VideoContent": {
+ "description": "Video content for a creative.",
+ "type": "object",
+ "properties": {
+ "videoUrl": {
+ "description": "The URL to fetch a video ad.",
+ "type": "string"
+ }
+ },
+ "id": "VideoContent"
},
"ImpressionMetricsRow": {
- "description": "The set of metrics that are measured in numbers of impressions, representing\nhow many impressions with the specified dimension values were considered\neligible at each stage of the bidding funnel.",
- "type": "object",
"properties": {
"responsesWithBids": {
"$ref": "MetricValue",
@@ -551,1225 +1750,21 @@
"description": "The values of all dimensions associated with metric values in this row."
},
"availableImpressions": {
- "$ref": "MetricValue",
- "description": "The number of impressions available to the buyer on Ad Exchange.\nIn some cases this value may be unavailable."
+ "description": "The number of impressions available to the buyer on Ad Exchange.\nIn some cases this value may be unavailable.",
+ "$ref": "MetricValue"
},
"inventoryMatches": {
- "description": "The number of impressions that match the buyer's inventory pretargeting.",
- "$ref": "MetricValue"
+ "$ref": "MetricValue",
+ "description": "The number of impressions that match the buyer's inventory pretargeting."
},
"bidRequests": {
- "description": "The number of impressions for which Ad Exchange sent the buyer a bid\nrequest.",
- "$ref": "MetricValue"
- }
- },
- "id": "ImpressionMetricsRow"
- },
- "AuctionContext": {
- "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": {
- "enum": [
- "OPEN_AUCTION",
- "DIRECT_DEALS"
- ],
- "type": "string"
- }
- }
- },
- "id": "AuctionContext",
- "description": "@OutputOnly The auction type the restriction applies to.",
- "type": "object"
- },
- "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"
- }
- }
- },
- "id": "ListImpressionMetricsResponse"
- },
- "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": {
- "rowDimensions": {
- "description": "The values of all dimensions associated with metric values in this row.",
- "$ref": "RowDimensions"
- },
- "viewableImpressions": {
"$ref": "MetricValue",
- "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View)."
- },
- "impressionsWon": {
- "description": "The number of bids that won an impression.",
- "$ref": "MetricValue"
- },
- "measurableImpressions": {
- "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View).",
- "$ref": "MetricValue"
- },
- "bids": {
- "$ref": "MetricValue",
- "description": "The number of bids that Ad Exchange received from the buyer."
- },
- "billedImpressions": {
- "$ref": "MetricValue",
- "description": "The number of bids for which the buyer was billed."
- },
- "bidsInAuction": {
- "description": "The number of bids that were permitted to compete in the auction.",
- "$ref": "MetricValue"
+ "description": "The number of impressions for which Ad Exchange sent the buyer a bid\nrequest."
}
},
- "id": "BidMetricsRow"
- },
- "ListBidResponseErrorsResponse": {
- "description": "Response message for listing all reasons that bid responses resulted in an\nerror.",
- "type": "object",
- "properties": {
- "calloutStatusRows": {
- "description": "List of rows, with counts of bid responses aggregated by callout status.",
- "type": "array",
- "items": {
- "$ref": "CalloutStatusRow"
- }
- },
- "nextPageToken": {
- "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": {
- "type": "object",
- "properties": {
- "rowDimensions": {
- "$ref": "RowDimensions",
- "description": "The values of all dimensions associated with metric values in this row."
- },
- "creativeStatusId": {
- "type": "integer",
- "description": "The ID of the creative status.\nSee [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).",
- "format": "int32"
- },
- "bidCount": {
- "$ref": "MetricValue",
- "description": "The number of bids with the specified status."
- }
- },
- "id": "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."
- },
- "RealtimeTimeRange": {
- "properties": {
- "startTimestamp": {
- "description": "The start timestamp of the real-time RTB metrics aggregation.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "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.",
+ "id": "ImpressionMetricsRow",
+ "description": "The set of metrics that are measured in numbers of impressions, representing\nhow many impressions with the specified dimension values were considered\neligible at each stage of the bidding funnel.",
"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": {
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined status.\nThis value will never be returned in responses.",
- "The buyer was not billed because the ad was not rendered by the\npublisher.",
- "The buyer was not billed because the impression won by the bid was\ndetermined to be invalid."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "AD_NOT_RENDERED",
- "INVALID_IMPRESSION"
- ],
- "description": "The status specifying why the winning bids were not billed."
- },
- "rowDimensions": {
- "description": "The values of all dimensions associated with metric values in this row.",
- "$ref": "RowDimensions"
- },
- "bidCount": {
- "$ref": "MetricValue",
- "description": "The number of bids with the specified status."
- }
- },
- "id": "NonBillableWinningBidStatusRow"
- },
- "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"
- },
- "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"
- }
- },
- "id": "FilteredBidDetailRow"
- },
- "AbsoluteDateRange": {
- "properties": {
- "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."
- },
- "startDate": {
- "$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."
- }
- },
- "id": "AbsoluteDateRange",
- "description": "An absolute date range, specified by its start date and end date.\nThe supported range of dates begins 30 days before today and ends today.\nValidity checked upon filter set creation. If a filter set with an absolute\ndate range is run at a later date more than 30 days after start_date, it will\nfail.",
- "type": "object"
- },
- "AddDealAssociationRequest": {
- "description": "A request for associating a deal and a creative.",
- "type": "object",
- "properties": {
- "association": {
- "$ref": "CreativeDealAssociation",
- "description": "The association between a creative and a deal that should be added."
- }
- },
- "id": "AddDealAssociationRequest"
- },
- "WatchCreativeRequest": {
- "properties": {
- "topic": {
- "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",
- "description": "A request for watching changes to creative Status.",
- "type": "object"
- },
- "TimeInterval": {
- "description": "An interval of time, with an absolute start and end.",
- "type": "object",
- "properties": {
- "startTime": {
- "description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.",
- "format": "google-datetime",
- "type": "string"
- },
- "endTime": {
- "description": "The timestamp marking the end of the range (exclusive) for which data is\nincluded.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "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"
- },
- "creativeId": {
- "description": "The ID of the creative.",
- "type": "string"
- }
- },
- "id": "FilteredBidCreativeRow"
- },
- "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",
- "type": "object",
- "properties": {
- "offsetDays": {
- "description": "The end date of the filter set, specified as the number of days before\ntoday. E.g. for a range where the last date is today, 0.",
- "format": "int32",
- "type": "integer"
- },
- "durationDays": {
- "description": "The number of days in the requested date range. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "RelativeDateRange"
- },
- "NativeContent": {
- "description": "Native content for a creative.",
- "type": "object",
- "properties": {
- "clickLinkUrl": {
- "description": "The URL that the browser/SDK will load when the user clicks the ad.",
- "type": "string"
- },
- "logo": {
- "$ref": "Image",
- "description": "A smaller image, for the advertiser's logo."
- },
- "priceDisplayText": {
- "description": "The price of the promoted app including currency info.",
- "type": "string"
- },
- "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": {
- "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"
- },
- "body": {
- "description": "A long description of the ad.",
- "type": "string"
- },
- "starRating": {
- "description": "The app rating in the app store. Must be in the range [0-5].",
- "format": "double",
- "type": "number"
- },
- "videoUrl": {
- "description": "The URL to fetch a native video ad.",
- "type": "string"
- }
- },
- "id": "NativeContent"
- },
- "ListClientsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list method\nto retrieve the next page of results."
- },
- "clients": {
- "description": "The returned list of clients.",
- "type": "array",
- "items": {
- "$ref": "Client"
- }
- }
- },
- "id": "ListClientsResponse"
- },
- "ListBidResponsesWithoutBidsResponse": {
- "description": "Response message for listing all reasons that bid responses were considered\nto have no applicable bids.",
- "type": "object",
- "properties": {
- "bidResponseWithoutBidsStatusRows": {
- "description": "List of rows, with counts of bid responses without bids aggregated by\nstatus.",
- "type": "array",
- "items": {
- "$ref": "BidResponseWithoutBidsStatusRow"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponsesWithoutBidsRequest.pageToken\nfield in the subsequent call to the bidResponsesWithoutBids.list\nmethod to retrieve the next page of results.",
- "type": "string"
- }
- },
- "id": "ListBidResponsesWithoutBidsResponse"
- },
- "ServingContext": {
- "properties": {
- "appType": {
- "$ref": "AppContext",
- "description": "Matches impressions for a particular app type."
- },
- "securityType": {
- "$ref": "SecurityContext",
- "description": "Matches impressions for a particular security type."
- },
- "platform": {
- "$ref": "PlatformContext",
- "description": "Matches impressions coming from a particular platform."
- },
- "location": {
- "$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"
- },
- "all": {
- "description": "Matches all contexts.",
- "type": "string",
- "enumDescriptions": [
- "A simple context."
- ],
- "enum": [
- "SIMPLE_CONTEXT"
- ]
- }
- },
- "id": "ServingContext",
- "description": "The serving context for this restriction.",
- "type": "object"
- },
- "Image": {
- "type": "object",
- "properties": {
- "width": {
- "description": "Image width in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "url": {
- "description": "The URL of the image.",
- "type": "string"
- },
- "height": {
- "description": "Image height in pixels.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Image",
- "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved."
- },
- "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": {
- "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",
- "description": "The number of impressions with the specified dimension values that were\nconsidered to have no applicable bids, as described by the specified status."
- },
- "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": {
- "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"
- },
- "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"
- }
- },
- "id": "ClientUserInvitation"
- },
- "ListClientUserInvitationsResponse": {
- "type": "object",
- "properties": {
- "invitations": {
- "description": "The returned list of client users.",
- "type": "array",
- "items": {
- "$ref": "ClientUserInvitation"
- }
- },
- "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"
- }
- },
- "id": "ListClientUserInvitationsResponse"
- },
- "ListClientUsersResponse": {
- "type": "object",
- "properties": {
- "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"
- },
- "users": {
- "description": "The returned list of client users.",
- "type": "array",
- "items": {
- "$ref": "ClientUser"
- }
- }
- },
- "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": {
- "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"
- },
- "detailType": {
- "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"
- ],
- "description": "The type of detail that the detail IDs represent.",
- "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": {
- "description": "The platforms this restriction applies to.",
- "type": "array",
- "items": {
- "enum": [
- "DESKTOP",
- "ANDROID",
- "IOS"
- ],
- "type": "string"
- },
- "enumDescriptions": [
- "Desktop platform.",
- "Android platform.",
- "iOS platform."
- ]
- }
- },
- "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": {
- "properties": {
- "status": {
- "description": "The status of the client user.",
- "type": "string",
- "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"
- ]
- },
- "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": {
- "type": "string",
- "description": "User's email address. The value of this field\nis ignored in an update operation."
- },
- "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"
- }
- },
- "id": "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"
- },
- "CreativeDealAssociation": {
- "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",
- "description": "The association between a creative and a deal.",
- "type": "object"
- },
- "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"
- },
- "Creative": {
- "properties": {
- "advertiserName": {
- "description": "The name of the company being advertised in the creative.",
- "type": "string"
- },
- "detectedAdvertiserIds": {
- "type": "array",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "description": "@OutputOnly Detected advertiser IDs, if any."
- },
- "detectedDomains": {
- "description": "@OutputOnly\nThe detected domains for this creative.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "filteringStats": {
- "$ref": "FilteringStats",
- "description": "@OutputOnly The filtering stats for this creative."
- },
- "attributes": {
- "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."
- ],
- "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."
- },
- "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."
- },
- "video": {
- "$ref": "VideoContent",
- "description": "A video 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"
- }
- },
- "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"
- }
- },
- "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"
- }
- },
- "adChoicesDestinationUrl": {
- "type": "string",
- "description": "The link to AdChoices destination page."
- },
- "restrictedCategories": {
- "description": "All restricted categories for the ads that may be shown from this creative.",
- "type": "array",
- "items": {
- "enum": [
- "NO_RESTRICTED_CATEGORIES",
- "ALCOHOL"
- ],
- "type": "string"
- },
- "enumDescriptions": [
- "The ad has no restricted categories",
- "The alcohol restricted category."
- ]
- },
- "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": {
- "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"
- ],
- "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."
- }
- },
- "id": "Creative",
- "description": "A creative and its classification data.",
- "type": "object"
- },
- "RemoveDealAssociationRequest": {
- "description": "A request for removing the association between a deal and a creative.",
- "type": "object",
- "properties": {
- "association": {
- "$ref": "CreativeDealAssociation",
- "description": "The association between a creative and a deal that should be removed."
- }
- },
- "id": "RemoveDealAssociationRequest"
- },
- "ListCreativeStatusBreakdownByCreativeResponse": {
- "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": {
- "description": "List of rows, with counts of bids with a given creative status aggregated\nby creative.",
- "type": "array",
- "items": {
- "$ref": "FilteredBidCreativeRow"
- }
- }
- },
- "id": "ListCreativeStatusBreakdownByCreativeResponse",
- "description": "Response message for listing all creatives associated with a given filtered\nbid reason."
- },
- "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": {
- "partnerClientId": {
- "description": "Optional arbitrary unique identifier of this client buyer from the\nstandpoint of its Ad Exchange sponsor buyer.\n\nThis field can be used to associate a client buyer with the identifier\nin the namespace of its sponsor buyer, lookup client buyers by that\nidentifier and verify whether an Ad Exchange counterpart of a given client\nbuyer already exists.\n\nIf present, must be unique among all the client buyers for its\nAd Exchange sponsor buyer.",
- "type": "string"
- },
- "entityType": {
- "enumDescriptions": [
- "A placeholder for an undefined client entity type. Should not be used.",
- "An advertiser.",
- "A brand.",
- "An advertising agency."
- ],
- "enum": [
- "ENTITY_TYPE_UNSPECIFIED",
- "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": {
- "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.",
- "Users associated with this client can respond to deal proposals\nsent to them by publishers. They can also initiate deal proposals\nof their own.",
- "Users associated with this client can approve eligible deals\non your behalf. Some deals may still explicitly require publisher\nfinalization. If this role is not selected, the sponsor buyer\nwill need to manually approve each of their deals."
- ],
- "enum": [
- "CLIENT_ROLE_UNSPECIFIED",
- "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`."
- },
- "visibleToSeller": {
- "description": "Whether the client buyer will be visible to sellers.",
- "type": "boolean"
- },
- "entityId": {
- "description": "Numerical identifier of the client entity.\nThe entity can be an advertiser, a brand, or an agency.\nThis identifier is unique among all the entities with the same type.\n\nA list of all known advertisers with their identifiers is available in the\n[advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all known brands with their identifiers is available in the\n[brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known agencies with their identifiers is available in the\n[agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.",
- "format": "int64",
- "type": "string"
- },
- "clientAccountId": {
- "type": "string",
- "description": "The globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations.",
- "format": "int64"
- },
- "entityName": {
- "description": "The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations.",
- "type": "string"
- },
- "status": {
- "description": "The status of the client buyer.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined client status.",
- "A client that is currently disabled.",
- "A client that is currently active."
- ],
- "enum": [
- "CLIENT_STATUS_UNSPECIFIED",
- "DISABLED",
- "ACTIVE"
- ]
- }
- },
- "id": "Client"
- },
- "Correction": {
- "description": "@OutputOnly Shows any corrections that were applied to this creative.",
- "type": "object",
- "properties": {
- "type": {
- "description": "The type of correction that was applied to the creative.",
- "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."
- ],
- "enum": [
- "CORRECTION_TYPE_UNSPECIFIED",
- "VENDOR_IDS_ADDED",
- "SSL_ATTRIBUTE_REMOVED",
- "FLASH_FREE_ATTRIBUTE_REMOVED",
- "FLASH_FREE_ATTRIBUTE_ADDED",
- "REQUIRED_ATTRIBUTE_ADDED",
- "REQUIRED_VENDOR_ADDED",
- "SSL_ATTRIBUTE_ADDED",
- "IN_BANNER_VIDEO_ATTRIBUTE_ADDED",
- "MRAID_ATTRIBUTE_ADDED",
- "FLASH_ATTRIBUTE_REMOVED",
- "VIDEO_IN_SNIPPET_ATTRIBUTE_ADDED"
- ]
- },
- "contexts": {
- "description": "The contexts for the correction.",
- "type": "array",
- "items": {
- "$ref": "ServingContext"
- }
- },
- "details": {
- "description": "Additional details about what was corrected.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "Correction"
- },
- "FilterSet": {
- "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": {
- "sellerNetworkIds": {
- "description": "The list of IDs of the seller (publisher) networks on which to filter;\nmay be empty. The filters represented by multiple seller network IDs are\nORed together (i.e. if non-empty, results must match any one of the\npublisher networks).\nSee [seller-network-ids](https://developers.google.com/ad-exchange/rtb/downloads/seller-network-ids)\nfile for the set of existing seller network IDs.",
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "absoluteDateRange": {
- "$ref": "AbsoluteDateRange",
- "description": "An absolute date range, defined by a start date and an end date.\nInterpreted relative to Pacific time zone."
- },
- "environment": {
- "enum": [
- "ENVIRONMENT_UNSPECIFIED",
- "WEB",
- "APP"
- ],
- "description": "The environment on which to filter; optional.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined environment; indicates that no environment\nfilter will be applied.",
- "The ad impression appears on the web.",
- "The ad impression appears in an app."
- ]
- },
- "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": {
- "enum": [
- "FORMAT_UNSPECIFIED",
- "DISPLAY",
- "VIDEO"
- ],
- "description": "DEPRECATED: use repeated formats field instead.\nThe format on which to filter; optional.",
- "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."
- ]
- },
- "timeSeriesGranularity": {
- "type": "string",
- "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."
- },
- "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": {
- "enum": [
- "FORMAT_UNSPECIFIED",
- "DISPLAY",
- "VIDEO"
- ],
- "type": "string"
- }
- },
- "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"
- },
- "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": {
- "enum": [
- "PLATFORM_UNSPECIFIED",
- "DESKTOP",
- "TABLET",
- "MOBILE"
- ],
- "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"
- },
- "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.",
- "type": "string"
- }
- },
- "id": "FilterSet"
}
},
"protocol": "rest",
@@ -1798,130 +1793,140 @@
"resources": {
"filterSets": {
"methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
+ "create": {
+ "id": "adexchangebuyer2.bidders.filterSets.create",
+ "path": "v2beta1/{+ownerName}/filterSets",
+ "request": {
+ "$ref": "FilterSet"
},
+ "description": "Creates the specified filter set for the account with the given account ID.",
+ "httpMethod": "POST",
"parameterOrder": [
- "name"
+ "ownerName"
],
- "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/[^/]+/filterSets/[^/]+$"
- }
- },
- "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": {
"response": {
"$ref": "FilterSet"
},
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"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"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}",
- "path": "v2beta1/{+name}",
- "id": "adexchangebuyer2.bidders.filterSets.get",
- "description": "Retrieves the requested filter set for the account with the given account\nID."
- },
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "pageToken": {
- "type": "string",
- "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."
- },
- "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 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/[^/]+$",
- "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`"
+ "location": "path"
+ },
+ "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"
}
},
- "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.",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets"
+ },
+ "delete": {
+ "id": "adexchangebuyer2.bidders.filterSets.delete",
+ "path": "v2beta1/{+name}",
+ "description": "Deletes the requested filter set from the account with the given account\nID.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}"
+ },
+ "get": {
+ "id": "adexchangebuyer2.bidders.filterSets.get",
+ "path": "v2beta1/{+name}",
+ "description": "Retrieves the requested filter set for the account with the given account\nID.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}"
+ },
+ "list": {
"httpMethod": "GET",
"parameterOrder": [
"ownerName"
],
"response": {
"$ref": "ListFilterSetsResponse"
- }
- },
- "create": {
- "description": "Creates the specified filter set for the account with the given account ID.",
- "request": {
- "$ref": "FilterSet"
},
- "response": {
- "$ref": "FilterSet"
+ "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": {
+ "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"
+ }
},
- "parameterOrder": [
- "ownerName"
- ],
- "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
- "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/[^/]+$"
- },
- "isTransient": {
- "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",
- "location": "query"
- }
- },
"flatPath": "v2beta1/bidders/{biddersId}/filterSets",
+ "id": "adexchangebuyer2.bidders.filterSets.list",
"path": "v2beta1/{+ownerName}/filterSets",
- "id": "adexchangebuyer2.bidders.filterSets.create"
+ "description": "Lists all filter sets for the account with the given account ID."
}
},
"resources": {
- "filteredBidRequests": {
+ "nonBillableWinningBids": {
"methods": {
"list": {
+ "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",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
@@ -1935,7 +1940,7 @@
},
"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.",
+ "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": {
@@ -1945,68 +1950,101 @@
"location": "query"
}
},
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBidRequests",
- "path": "v2beta1/{+filterSetName}/filteredBidRequests",
- "id": "adexchangebuyer2.bidders.filterSets.filteredBidRequests.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"
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/nonBillableWinningBids"
}
}
},
- "nonBillableWinningBids": {
+ "filteredBids": {
"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"
+ "$ref": "ListFilteredBidsResponse"
},
"parameterOrder": [
"filterSetName"
],
"httpMethod": "GET",
- "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"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/nonBillableWinningBids",
- "path": "v2beta1/{+filterSetName}/nonBillableWinningBids",
- "id": "adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list"
+ "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\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the filteredBids.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}/filteredBids",
+ "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."
}
- }
- },
- "filteredBids": {
+ },
"resources": {
+ "details": {
+ "methods": {
+ "list": {
+ "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/[^/]+/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": {
+ "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": {
+ "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}/filteredBids/{creativeStatusId}/details",
+ "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details",
+ "id": "adexchangebuyer2.bidders.filterSets.filteredBids.details.list",
+ "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail."
+ }
+ }
+ },
"creatives": {
"methods": {
"list": {
- "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives",
- "id": "adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list",
- "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.",
"response": {
"$ref": "ListCreativeStatusBreakdownByCreativeResponse"
},
@@ -2015,13 +2053,16 @@
"creativeStatusId"
],
"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",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
- "location": "path"
+ "type": "string"
},
"creativeStatusId": {
"location": "path",
@@ -2036,124 +2077,41 @@
"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",
- "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}/filteredBids/{creativeStatusId}/creatives"
- }
- }
- },
- "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"
- ]
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives",
+ "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives",
+ "id": "adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list",
+ "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative."
}
}
}
- },
- "methods": {
- "list": {
- "response": {
- "$ref": "ListFilteredBidsResponse"
- },
- "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": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids",
- "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."
- }
}
},
"losingBids": {
"methods": {
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "filterSetName"
- ],
"response": {
"$ref": "ListLosingBidsResponse"
},
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "httpMethod": "GET",
+ "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`"
+ "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",
@@ -2161,46 +2119,46 @@
"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",
- "location": "query"
+ "type": "integer"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/losingBids",
- "id": "adexchangebuyer2.bidders.filterSets.losingBids.list",
"path": "v2beta1/{+filterSetName}/losingBids",
+ "id": "adexchangebuyer2.bidders.filterSets.losingBids.list",
"description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason."
}
}
},
- "impressionMetrics": {
+ "bidMetrics": {
"methods": {
"list": {
- "response": {
- "$ref": "ListImpressionMetricsResponse"
- },
+ "id": "adexchangebuyer2.bidders.filterSets.bidMetrics.list",
+ "path": "v2beta1/{+filterSetName}/bidMetrics",
+ "description": "Lists all metrics that are measured in terms of number of bids.",
+ "httpMethod": "GET",
"parameterOrder": [
"filterSetName"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListBidMetricsResponse"
+ },
"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"
+ "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\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod.",
+ "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"
},
"pageSize": {
@@ -2210,50 +2168,47 @@
"type": "integer"
}
},
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/impressionMetrics",
- "path": "v2beta1/{+filterSetName}/impressionMetrics",
- "id": "adexchangebuyer2.bidders.filterSets.impressionMetrics.list",
- "description": "Lists all metrics that are measured in terms of number of impressions."
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidMetrics"
}
}
},
- "bidMetrics": {
+ "impressionMetrics": {
"methods": {
"list": {
- "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidMetrics",
- "id": "adexchangebuyer2.bidders.filterSets.bidMetrics.list",
- "path": "v2beta1/{+filterSetName}/bidMetrics",
- "description": "Lists all metrics that are measured in terms of number of bids.",
+ "description": "Lists all metrics that are measured in terms of number of impressions.",
"httpMethod": "GET",
- "response": {
- "$ref": "ListBidMetricsResponse"
- },
"parameterOrder": [
"filterSetName"
],
+ "response": {
+ "$ref": "ListImpressionMetricsResponse"
+ },
"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\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"
- },
- "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": {
- "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}/impressionMetrics",
+ "id": "adexchangebuyer2.bidders.filterSets.impressionMetrics.list",
+ "path": "v2beta1/{+filterSetName}/impressionMetrics"
}
}
},
@@ -2273,11 +2228,11 @@
],
"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",
- "pattern": "^bidders/[^/]+/filterSets/[^/]+$"
+ "type": "string"
},
"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.",
@@ -2308,16 +2263,13 @@
"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/[^/]+$"
+ "pattern": "^bidders/[^/]+/filterSets/[^/]+$",
+ "location": "path"
},
"pageToken": {
"location": "query",
@@ -2331,21 +2283,233 @@
"type": "integer"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponsesWithoutBids",
"path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids",
"id": "adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list"
}
}
+ },
+ "filteredBidRequests": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListFilteredBidRequestsResponse"
+ },
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "httpMethod": "GET",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBidRequests",
+ "path": "v2beta1/{+filterSetName}/filteredBidRequests",
+ "id": "adexchangebuyer2.bidders.filterSets.filteredBidRequests.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."
+ }
+ }
}
}
},
"accounts": {
"resources": {
"filterSets": {
+ "methods": {
+ "create": {
+ "path": "v2beta1/{+ownerName}/filterSets",
+ "id": "adexchangebuyer2.bidders.accounts.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": {
+ "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",
+ "location": "query"
+ },
+ "ownerName": {
+ "pattern": "^bidders/[^/]+/accounts/[^/]+$",
+ "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"
+ }
+ },
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/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}/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."
+ },
+ "get": {
+ "description": "Retrieves the requested filter set for the account with the given account\nID.",
+ "response": {
+ "$ref": "FilterSet"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "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"
+ }
+ },
+ "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"
+ },
+ "list": {
+ "path": "v2beta1/{+ownerName}/filterSets",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.list",
+ "description": "Lists all filter sets for the account with the given account ID.",
+ "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/[^/]+/accounts/[^/]+$",
+ "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": {
+ "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"
+ }
+ },
"resources": {
- "filteredBids": {
+ "bidResponseErrors": {
"methods": {
"list": {
+ "response": {
+ "$ref": "ListBidResponseErrorsResponse"
+ },
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "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"
+ },
+ "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": {
+ "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}/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": {
+ "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": {
"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`",
@@ -2355,9 +2519,9 @@
"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"
+ "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": {
"description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
@@ -2369,80 +2533,103 @@
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids",
- "path": "v2beta1/{+filterSetName}/filteredBids",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list",
- "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.",
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponsesWithoutBids",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list",
+ "path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids"
+ }
+ }
+ },
+ "filteredBidRequests": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListFilteredBidRequestsResponse"
+ },
+ "parameterOrder": [
+ "filterSetName"
+ ],
+ "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": {
+ "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",
+ "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."
+ }
+ }
+ },
+ "filteredBids": {
+ "methods": {
+ "list": {
"response": {
"$ref": "ListFilteredBidsResponse"
},
"parameterOrder": [
"filterSetName"
],
- "httpMethod": "GET"
+ "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"
+ },
+ "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}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids",
+ "path": "v2beta1/{+filterSetName}/filteredBids",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list",
+ "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason."
}
},
"resources": {
- "details": {
- "methods": {
- "list": {
- "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.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",
- "parameters": {
- "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"
- },
- "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 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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details"
- }
- }
- },
"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"
],
- "response": {
- "$ref": "ListCreativeStatusBreakdownByCreativeResponse"
- },
"parameters": {
"filterSetName": {
"pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
@@ -2459,7 +2646,55 @@
"location": "path"
},
"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"
+ ],
+ "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."
+ }
+ }
+ },
+ "details": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListCreativeStatusBreakdownByDetailResponse"
+ },
+ "parameterOrder": [
+ "filterSetName",
+ "creativeStatusId"
+ ],
+ "httpMethod": "GET",
+ "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": {
+ "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"
},
@@ -2473,9 +2708,10 @@
"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"
+ "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",
+ "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail."
}
}
}
@@ -2484,13 +2720,14 @@
"nonBillableWinningBids": {
"methods": {
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "filterSetName"
- ],
+ "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",
"parameters": {
"filterSetName": {
"pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
@@ -2500,9 +2737,9 @@
"type": "string"
},
"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"
+ "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.",
@@ -2515,29 +2752,31 @@
"https://www.googleapis.com/auth/adexchange.buyer"
],
"flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/nonBillableWinningBids",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list",
"path": "v2beta1/{+filterSetName}/nonBillableWinningBids",
- "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason."
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list"
}
}
},
"losingBids": {
"methods": {
"list": {
- "httpMethod": "GET",
"response": {
"$ref": "ListLosingBidsResponse"
},
"parameterOrder": [
"filterSetName"
],
+ "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",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
- "location": "path"
+ "type": "string"
},
"pageToken": {
"location": "query",
@@ -2545,18 +2784,15 @@
"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"
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/losingBids",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.losingBids.list",
"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."
}
}
@@ -2564,7 +2800,6 @@
"impressionMetrics": {
"methods": {
"list": {
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/impressionMetrics",
"path": "v2beta1/{+filterSetName}/impressionMetrics",
"id": "adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list",
"description": "Lists all metrics that are measured in terms of number of impressions.",
@@ -2580,11 +2815,11 @@
],
"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",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
- "location": "path"
+ "type": "string"
},
"pageToken": {
"location": "query",
@@ -2597,31 +2832,28 @@
"type": "integer",
"location": "query"
}
- }
+ },
+ "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",
"response": {
"$ref": "ListBidMetricsResponse"
},
"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/[^/]+$"
+ "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$",
+ "location": "path"
},
"pageToken": {
"location": "query",
@@ -2637,250 +2869,13 @@
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ ],
+ "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidMetrics",
+ "path": "v2beta1/{+filterSetName}/bidMetrics",
+ "id": "adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list",
+ "description": "Lists all metrics that are measured in terms of number of bids."
}
}
- },
- "bidResponseErrors": {
- "methods": {
- "list": {
- "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/[^/]+/accounts/[^/]+/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"
- ],
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponseErrors",
- "id": "adexchangebuyer2.bidders.accounts.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."
- }
- }
- },
- "bidResponsesWithoutBids": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListBidResponsesWithoutBidsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "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": {
- "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": {
- "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}/bidResponsesWithoutBids",
- "path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids",
- "id": "adexchangebuyer2.bidders.accounts.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."
- }
- }
- },
- "filteredBidRequests": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListFilteredBidRequestsResponse"
- },
- "parameterOrder": [
- "filterSetName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "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": {
- "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}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBidRequests",
- "path": "v2beta1/{+filterSetName}/filteredBidRequests",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.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."
- }
- }
- }
- },
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^bidders/[^/]+/accounts/[^/]+/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`"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "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."
- },
- "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.",
- "response": {
- "$ref": "FilterSet"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET"
- },
- "list": {
- "description": "Lists all filter sets for the account with the given account ID.",
- "response": {
- "$ref": "ListFilterSetsResponse"
- },
- "parameterOrder": [
- "ownerName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "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": {
- "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"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets",
- "path": "v2beta1/{+ownerName}/filterSets",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.list"
- },
- "create": {
- "description": "Creates the specified filter set for the account with the given account ID.",
- "request": {
- "$ref": "FilterSet"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "ownerName"
- ],
- "response": {
- "$ref": "FilterSet"
- },
- "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": {
- "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/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets",
- "id": "adexchangebuyer2.bidders.accounts.filterSets.create",
- "path": "v2beta1/{+ownerName}/filterSets"
}
}
}
@@ -2890,342 +2885,330 @@
},
"accounts": {
"resources": {
- "creatives": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListCreativesResponse"
- },
- "parameterOrder": [
- "accountId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "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": {
- "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",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "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."
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/creatives",
- "path": "v2beta1/accounts/{accountId}/creatives",
- "id": "adexchangebuyer2.accounts.creatives.list",
- "description": "Lists creatives."
- },
- "create": {
- "flatPath": "v2beta1/accounts/{accountId}/creatives",
- "id": "adexchangebuyer2.accounts.creatives.create",
- "path": "v2beta1/accounts/{accountId}/creatives",
- "request": {
- "$ref": "Creative"
- },
- "description": "Creates a creative.",
- "httpMethod": "POST",
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "Creative"
- },
- "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"
- },
- "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)."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "stopWatching": {
- "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.",
- "request": {
- "$ref": "StopWatchingCreativeRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "parameters": {
- "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"
- },
- "accountId": {
- "location": "path",
- "description": "The account of the creative to stop notifications for.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
- "id": "adexchangebuyer2.accounts.creatives.stopWatching",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching"
- },
- "get": {
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "id": "adexchangebuyer2.accounts.creatives.get",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "description": "Gets a creative.",
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "response": {
- "$ref": "Creative"
- },
- "parameters": {
- "accountId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The account the creative belongs to."
- },
- "creativeId": {
- "description": "The ID of the creative to retrieve.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "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": {
- "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"
- },
- "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"
- }
- },
+ "clients": {
"resources": {
- "dealAssociations": {
+ "invitations": {
"methods": {
- "list": {
- "description": "List all creative-deal associations.",
- "response": {
- "$ref": "ListDealAssociationsResponse"
- },
+ "get": {
+ "httpMethod": "GET",
"parameterOrder": [
"accountId",
- "creativeId"
+ "clientAccountId",
+ "invitationId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ClientUserInvitation"
+ },
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
- "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": {
- "description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.",
+ "invitationId": {
+ "description": "Numerical identifier of the user invitation to retrieve. (required)",
+ "format": "int64",
"required": true,
"type": "string",
"location": "path"
},
- "pageToken": {
+ "accountId": {
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "required": true,
"type": "string",
- "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."
+ "location": "path"
+ },
+ "clientAccountId": {
+ "location": "path",
+ "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"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
+ "id": "adexchangebuyer2.accounts.clients.invitations.get",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
+ "description": "Retrieves an existing client user invitation."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "response": {
+ "$ref": "ListClientUserInvitationsResponse"
+ },
+ "parameters": {
+ "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"
+ },
+ "accountId": {
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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"
+ }
+ },
+ "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",
+ "description": "Lists all the client users invitations for a client\nwith a given account ID."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "response": {
+ "$ref": "ClientUserInvitation"
+ },
+ "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",
+ "id": "adexchangebuyer2.accounts.clients.invitations.create",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.",
+ "request": {
+ "$ref": "ClientUserInvitation"
+ }
+ }
+ }
+ },
+ "users": {
+ "methods": {
+ "update": {
+ "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": {
+ "userId": {
+ "description": "Numerical identifier of the user to retrieve. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}"
+ },
+ "list": {
+ "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": {
+ "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": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.",
+ "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. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.",
+ "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}/creatives/{creativeId}/dealAssociations",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list"
- },
- "add": {
- "request": {
- "$ref": "AddDealAssociationRequest"
- },
- "description": "Associate an existing deal with a creative.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "accountId": {
+ },
+ "clientAccountId": {
"location": "path",
- "description": "The account the creative belongs to.",
+ "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"
- },
- "creativeId": {
- "description": "The ID of the creative associated with the deal.",
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users"
+ },
+ "get": {
+ "id": "adexchangebuyer2.accounts.clients.users.get",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "description": "Retrieves an existing client user.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId",
+ "userId"
+ ],
+ "response": {
+ "$ref": "ClientUser"
+ },
+ "parameters": {
+ "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"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add"
- },
- "remove": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "POST",
- "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.",
+ "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\nthat the user to be retrieved is associated with. (required)",
+ "format": "int64",
"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"
- }
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}"
}
}
}
- }
- },
- "clients": {
+ },
"methods": {
+ "update": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "accountId",
+ "clientAccountId"
+ ],
+ "response": {
+ "$ref": "Client"
+ },
+ "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"
+ }
+ },
+ "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}",
+ "request": {
+ "$ref": "Client"
+ },
+ "description": "Updates an existing client buyer."
+ },
+ "create": {
+ "id": "adexchangebuyer2.accounts.clients.create",
+ "path": "v2beta1/accounts/{accountId}/clients",
+ "request": {
+ "$ref": "Client"
+ },
+ "description": "Creates a new client buyer.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "response": {
+ "$ref": "Client"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/clients"
+ },
"get": {
"response": {
"$ref": "Client"
@@ -3260,13 +3243,13 @@
"description": "Gets a client buyer with a given client account ID."
},
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId"
- ],
"response": {
"$ref": "ListClientsResponse"
},
+ "parameterOrder": [
+ "accountId"
+ ],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
@@ -3289,96 +3272,326 @@
"type": "string"
},
"pageSize": {
+ "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",
- "type": "integer",
- "location": "query"
+ "type": "integer"
}
},
"flatPath": "v2beta1/accounts/{accountId}/clients",
- "id": "adexchangebuyer2.accounts.clients.list",
"path": "v2beta1/accounts/{accountId}/clients",
+ "id": "adexchangebuyer2.accounts.clients.list",
"description": "Lists all the clients for the current sponsor buyer."
- },
+ }
+ }
+ },
+ "creatives": {
+ "methods": {
"update": {
"response": {
- "$ref": "Client"
+ "$ref": "Creative"
},
"parameterOrder": [
"accountId",
- "clientAccountId"
+ "creativeId"
],
"httpMethod": "PUT",
- "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",
+ "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
}
},
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
- "id": "adexchangebuyer2.accounts.clients.update",
- "description": "Updates an existing client buyer.",
+ "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": "Client"
- }
+ "$ref": "Creative"
+ },
+ "description": "Updates a creative."
},
- "create": {
+ "list": {
"response": {
- "$ref": "Client"
+ "$ref": "ListCreativesResponse"
},
"parameterOrder": [
"accountId"
],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "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"
+ },
+ "accountId": {
+ "description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives",
+ "path": "v2beta1/accounts/{accountId}/creatives",
+ "id": "adexchangebuyer2.accounts.creatives.list",
+ "description": "Lists creatives."
+ },
+ "create": {
+ "path": "v2beta1/accounts/{accountId}/creatives",
+ "id": "adexchangebuyer2.accounts.creatives.create",
+ "request": {
+ "$ref": "Creative"
+ },
+ "description": "Creates a creative.",
+ "response": {
+ "$ref": "Creative"
+ },
+ "parameterOrder": [
+ "accountId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "duplicateIdMode": {
+ "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",
+ "location": "query"
+ },
+ "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"
+ },
+ "stopWatching": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
+ "creativeId": {
+ "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "accountId": {
+ "description": "The account of the creative to stop notifications for.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
+ "id": "adexchangebuyer2.accounts.creatives.stopWatching",
+ "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.",
+ "request": {
+ "$ref": "StopWatchingCreativeRequest"
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "Creative"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "httpMethod": "GET",
+ "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",
+ "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}/clients",
- "path": "v2beta1/accounts/{accountId}/clients",
- "id": "adexchangebuyer2.accounts.clients.create",
- "description": "Creates a new client buyer.",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "id": "adexchangebuyer2.accounts.creatives.get",
+ "description": "Gets a creative."
+ },
+ "watch": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "httpMethod": "POST",
+ "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": {
+ "description": "The account of the creative to watch.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
+ "id": "adexchangebuyer2.accounts.creatives.watch",
"request": {
- "$ref": "Client"
- }
+ "$ref": "WatchCreativeRequest"
+ },
+ "description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status."
}
},
"resources": {
- "invitations": {
+ "dealAssociations": {
"methods": {
- "create": {
- "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.",
- "request": {
- "$ref": "ClientUserInvitation"
- },
+ "list": {
"response": {
- "$ref": "ClientUserInvitation"
+ "$ref": "ListDealAssociationsResponse"
},
"parameterOrder": [
"accountId",
- "clientAccountId"
+ "creativeId"
+ ],
+ "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\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method.",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
+ },
+ "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"
+ }
+ },
+ "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."
+ },
+ "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": {
+ "description": "The account the creative belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "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": {
+ "description": "Remove the association between a deal and a creative.",
+ "request": {
+ "$ref": "RemoveDealAssociationRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
],
"httpMethod": "POST",
"scopes": [
@@ -3386,239 +3599,21 @@
],
"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",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "id": "adexchangebuyer2.accounts.clients.invitations.create"
- },
- "get": {
- "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": {
- "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"
- }
- },
- "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",
- "description": "Retrieves an existing client user invitation."
- },
- "list": {
- "response": {
- "$ref": "ListClientUserInvitationsResponse"
- },
- "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\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.",
- "type": "string",
- "location": "query"
- },
- "accountId": {
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
+ "description": "The account the creative belongs to.",
"required": true,
"type": "string",
"location": "path"
},
- "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"
- }
- },
- "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."
- }
- }
- },
- "users": {
- "methods": {
- "list": {
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
- "id": "adexchangebuyer2.accounts.clients.users.list",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
- "description": "Lists all the known client users for a specified\nsponsor buyer account ID.",
- "httpMethod": "GET",
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "response": {
- "$ref": "ListClientUsersResponse"
- },
- "parameters": {
- "pageToken": {
- "location": "query",
- "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"
- },
- "accountId": {
- "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)",
- "format": "int64",
+ "creativeId": {
+ "description": "The ID of the creative associated with the deal.",
"required": true,
"type": "string",
"location": "path"
- },
- "pageSize": {
- "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",
- "type": "integer"
- },
- "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"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "get": {
- "parameters": {
- "userId": {
- "location": "path",
- "description": "Numerical identifier of the user to retrieve. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- },
- "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\nthat the user to be retrieved is associated with. (required)",
- "format": "int64"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "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.",
- "response": {
- "$ref": "ClientUser"
- },
- "parameterOrder": [
- "accountId",
- "clientAccountId",
- "userId"
- ],
- "httpMethod": "GET"
- },
- "update": {
- "parameters": {
- "userId": {
- "location": "path",
- "description": "Numerical identifier of the user to retrieve. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "id": "adexchangebuyer2.accounts.clients.users.update",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "request": {
- "$ref": "ClientUser"
- },
- "description": "Updates an existing client user.\nOnly the user status can be changed on update.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "accountId",
- "clientAccountId",
- "userId"
- ],
- "response": {
- "$ref": "ClientUser"
- }
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove"
}
}
}
@@ -3639,19 +3634,17 @@
"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": {
- "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"
@@ -3660,7 +3653,9 @@
"enum": [
"1",
"2"
- ]
+ ],
+ "description": "V1 error format.",
+ "type": "string"
},
"callback": {
"location": "query",
@@ -3668,7 +3663,6 @@
"type": "string"
},
"alt": {
- "default": "json",
"enum": [
"json",
"media",
@@ -3681,22 +3675,23 @@
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response."
- },
- "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"
+ "description": "Data format for response.",
+ "default": "json"
},
"access_token": {
+ "description": "OAuth access token.",
"type": "string",
- "location": "query",
- "description": "OAuth access token."
+ "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",
- "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",
@@ -3720,5 +3715,10 @@
"servicePath": "",
"kind": "discovery#restDescription",
"description": "Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.",
- "basePath": ""
+ "basePath": "",
+ "revision": "20171214",
+ "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/reference/rest/",
+ "id": "adexchangebuyer2:v2beta1",
+ "discoveryVersion": "v1",
+ "version_module": true
}
diff --git a/adexperiencereport/v1/adexperiencereport-api.json b/adexperiencereport/v1/adexperiencereport-api.json
index 5430d01..21db9c4 100644
--- a/adexperiencereport/v1/adexperiencereport-api.json
+++ b/adexperiencereport/v1/adexperiencereport-api.json
@@ -1,11 +1,142 @@
{
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "schemas": {
+ "PlatformSummary": {
+ "description": "Summary of the ad experience rating of a site for a specific platform.",
+ "type": "object",
+ "properties": {
+ "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."
+ ]
+ },
+ "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": {
+ "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"
+ ],
+ "description": "The ad filtering status of the site.",
+ "type": "string"
+ },
+ "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"
+ },
+ "lastChangeTime": {
+ "description": "The last time that the site changed status.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "PlatformSummary"
+ },
+ "ViolatingSitesResponse": {
+ "properties": {
+ "violatingSites": {
+ "description": "A list of summaries of violating sites.",
+ "type": "array",
+ "items": {
+ "$ref": "SiteSummaryResponse"
+ }
+ }
+ },
+ "id": "ViolatingSitesResponse",
+ "description": "Response message for ListViolatingSites.",
+ "type": "object"
+ },
+ "SiteSummaryResponse": {
+ "description": "Response message for GetSiteSummary.",
+ "type": "object",
+ "properties": {
+ "desktopSummary": {
+ "description": "Summary for the desktop review of the site.",
+ "$ref": "PlatformSummary"
+ },
+ "mobileSummary": {
+ "description": "Summary for the mobile review of the site.",
+ "$ref": "PlatformSummary"
+ },
+ "reviewedSite": {
+ "description": "The name of the site reviewed.",
+ "type": "string"
+ }
+ },
+ "id": "SiteSummaryResponse"
+ }
+ },
+ "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": "Ad Experience Report",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/xapi.zoo": {
+ "description": "Test scope for access to the Zoo service"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://adexperiencereport.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "adexperiencereport",
+ "batchPath": "batch",
"title": "Google Ad Experience Report API",
"ownerName": "Google",
"resources": {
"sites": {
"methods": {
"get": {
- "description": "Gets a summary of the ad experience rating of a site.",
"response": {
"$ref": "SiteSummaryResponse"
},
@@ -27,7 +158,8 @@
},
"flatPath": "v1/sites/{sitesId}",
"path": "v1/{+name}",
- "id": "adexperiencereport.sites.get"
+ "id": "adexperiencereport.sites.get",
+ "description": "Gets a summary of the ad experience rating of a site."
}
}
},
@@ -53,26 +185,26 @@
},
"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": {
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "fields": {
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "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",
@@ -87,12 +219,11 @@
"location": "query"
},
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"alt": {
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -105,12 +236,13 @@
"json",
"media",
"proto"
- ]
+ ],
+ "type": "string"
},
"access_token": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"key": {
"location": "query",
@@ -118,9 +250,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.",
@@ -147,137 +279,5 @@
"basePath": "",
"id": "adexperiencereport:v1",
"documentationLink": "https://developers.google.com/ad-experience-report/",
- "revision": "20171129",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "PlatformSummary": {
- "type": "object",
- "properties": {
- "reportUrl": {
- "description": "A link that leads to a full ad experience report.",
- "type": "string"
- },
- "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"
- },
- "enforcementTime": {
- "description": "The date on which ad filtering begins.",
- "format": "google-datetime",
- "type": "string"
- },
- "region": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "REGION_UNKNOWN",
- "REGION_A",
- "REGION_B"
- ]
- },
- "enumDescriptions": [
- "Ad standard not yet defined for your region.",
- "Region A.",
- "Region B."
- ],
- "description": "The assigned regions for the site and platform."
- },
- "filterStatus": {
- "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"
- ],
- "description": "The ad filtering status of the site.",
- "type": "string"
- },
- "underReview": {
- "description": "Whether the site is currently under review.",
- "type": "boolean"
- }
- },
- "id": "PlatformSummary",
- "description": "Summary of the ad experience rating of a site for a specific platform."
- },
- "ViolatingSitesResponse": {
- "description": "Response message for ListViolatingSites.",
- "type": "object",
- "properties": {
- "violatingSites": {
- "description": "A list of summaries of violating sites.",
- "type": "array",
- "items": {
- "$ref": "SiteSummaryResponse"
- }
- }
- },
- "id": "ViolatingSitesResponse"
- },
- "SiteSummaryResponse": {
- "id": "SiteSummaryResponse",
- "description": "Response message for GetSiteSummary.",
- "type": "object",
- "properties": {
- "desktopSummary": {
- "$ref": "PlatformSummary",
- "description": "Summary for the desktop review of the site."
- },
- "mobileSummary": {
- "$ref": "PlatformSummary",
- "description": "Summary for the mobile review of the site."
- },
- "reviewedSite": {
- "description": "The name of the site reviewed.",
- "type": "string"
- }
- }
- }
- },
- "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": {
- "scopes": {
- "https://www.googleapis.com/auth/xapi.zoo": {
- "description": "Test scope for access to the Zoo service"
- }
- }
- }
- },
- "rootUrl": "https://adexperiencereport.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "adexperiencereport",
- "batchPath": "batch"
+ "revision": "20171129"
}
diff --git a/analyticsreporting/v4/analyticsreporting-api.json b/analyticsreporting/v4/analyticsreporting-api.json
index 380a7c8..b16b906 100644
--- a/analyticsreporting/v4/analyticsreporting-api.json
+++ b/analyticsreporting/v4/analyticsreporting-api.json
@@ -1,15 +1,445 @@
{
- "basePath": "",
- "revision": "20171108",
- "documentationLink": "https://developers.google.com/analytics/devguides/reporting/core/v4/",
- "id": "analyticsreporting:v4",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "ReportData": {
- "description": "The data part of the report.",
+ "ReportRow": {
+ "properties": {
+ "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",
+ "description": "A row in the report.",
+ "type": "object"
+ },
+ "Cohort": {
+ "properties": {
+ "name": {
+ "description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...].",
+ "type": "string"
+ },
+ "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.",
+ "$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"
+ }
+ },
+ "id": "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.",
+ "type": "object"
+ },
+ "MetricFilterClause": {
+ "properties": {
+ "operator": {
+ "enumDescriptions": [
+ "Unspecified operator. It is treated as an `OR`.",
+ "The logical `OR` operator.",
+ "The logical `AND` operator."
+ ],
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "OR",
+ "AND"
+ ],
+ "description": "The operator for combining multiple metric filters. If unspecified, it is\ntreated as an `OR`.",
+ "type": "string"
+ },
+ "filters": {
+ "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricFilter"
+ }
+ }
+ },
+ "id": "MetricFilterClause",
+ "description": "Represents a group of metric filters.\nSet the operator value to specify how the filters are logically combined.",
+ "type": "object"
+ },
+ "OrFiltersForSegment": {
+ "properties": {
+ "segmentFilterClauses": {
+ "description": "List of segment filters to be combined with a `OR` operator.",
+ "type": "array",
+ "items": {
+ "$ref": "SegmentFilterClause"
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "DimensionFilterClause": {
+ "description": "A group of dimension filters. Set the operator value to specify how\nthe filters are logically combined.",
+ "type": "object",
+ "properties": {
+ "operator": {
+ "enumDescriptions": [
+ "Unspecified operator. It is treated as an `OR`.",
+ "The logical `OR` operator.",
+ "The logical `AND` operator."
+ ],
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "OR",
+ "AND"
+ ],
+ "description": "The operator for combining multiple dimension filters. If unspecified, it\nis treated as an `OR`.",
+ "type": "string"
+ },
+ "filters": {
+ "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
+ "type": "array",
+ "items": {
+ "$ref": "DimensionFilter"
+ }
+ }
+ },
+ "id": "DimensionFilterClause"
+ },
+ "GetReportsResponse": {
+ "description": "The main response class which holds the reports from the Reporting API\n`batchGet` call.",
+ "type": "object",
+ "properties": {
+ "reports": {
+ "description": "Responses corresponding to each of the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Report"
+ }
+ },
+ "queryCost": {
+ "description": "The amount of resource quota tokens deducted to execute the query. Includes\nall responses.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "resourceQuotasRemaining": {
+ "$ref": "ResourceQuotasRemaining",
+ "description": "The amount of resource quota remaining for the property."
+ }
+ },
+ "id": "GetReportsResponse"
+ },
+ "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": {
+ "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"
+ },
+ "SegmentMetricFilter": {
+ "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": {
+ "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.",
+ "Hit scope.",
+ "Session scope.",
+ "User scope."
+ ],
+ "enum": [
+ "UNSPECIFIED_SCOPE",
+ "PRODUCT",
+ "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.",
+ "type": "string"
+ },
+ "comparisonValue": {
+ "description": "The value to compare against. If the operator is `BETWEEN`, this value is\ntreated as minimum comparison value.",
+ "type": "string"
+ }
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "pivotValueRegions": {
+ "description": "The values of each pivot region.",
+ "type": "array",
+ "items": {
+ "$ref": "PivotValueRegion"
+ }
+ }
+ },
+ "id": "DateRangeValues"
+ },
+ "CohortGroup": {
+ "properties": {
+ "cohorts": {
+ "description": "The definition for the cohort.",
+ "type": "array",
+ "items": {
+ "$ref": "Cohort"
+ }
+ },
+ "lifetimeValue": {
+ "description": "Enable Life Time Value (LTV). LTV measures lifetime value for users\nacquired through different channels.\nPlease see:\n[Cohort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifetime Value](https://support.google.com/analytics/answer/6182550)\nIf the value of lifetimeValue is false:\n\n- The metric values are similar to the values in the web interface cohort\n report.\n- The cohort definition date ranges must be aligned to the calendar week\n and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in\n the cohort definition should be a Sunday and the `endDate` should be the\n following Saturday, and for `ga:cohortNthMonth`, the `startDate`\n should be the 1st of the month and `endDate` should be the last day\n of the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will correspond to the values in the web interface\n LifeTime value report.\n- The Lifetime Value report shows you how user value (Revenue) and\n engagement (Appviews, Goal Completions, Sessions, and Session Duration)\n grow during the 90 days after a user is acquired.\n- The metrics are calculated as a cumulative average per user per the time\n increment.\n- The cohort definition date ranges need not be aligned to the calendar\n week and month boundaries.\n- The `viewId` must be an\n [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)",
+ "type": "boolean"
+ }
+ },
+ "id": "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 }",
+ "type": "object"
+ },
+ "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.",
+ "type": "boolean"
+ },
+ "reportRequests": {
+ "description": "Requests, each request will have a separate response.\nThere can be a maximum of 5 requests. All requests should have the same\n`dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.",
+ "type": "array",
+ "items": {
+ "$ref": "ReportRequest"
+ }
+ }
+ },
+ "id": "GetReportsRequest"
+ },
+ "Pivot": {
+ "properties": {
+ "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",
+ "type": "integer"
+ },
+ "metrics": {
+ "description": "The pivot metrics. Pivot metrics are part of the\nrestriction on total number of metrics allowed in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Metric"
+ }
+ },
+ "dimensions": {
+ "description": "A list of dimensions to show as pivot columns. A Pivot can have a maximum\nof 4 dimensions. Pivot dimensions are part of the restriction on the\ntotal number of dimensions allowed in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Dimension"
+ }
+ },
+ "dimensionFilterClauses": {
+ "description": "DimensionFilterClauses are logically combined with an `AND` operator: only\ndata that is included by all these DimensionFilterClauses contributes to\nthe values in this pivot region. Dimension filters can be used to restrict\nthe columns shown in the pivot region. For example if you have\n`ga:browser` as the requested dimension in the pivot region, and you\nspecify key filters to restrict `ga:browser` to only \"IE\" or \"Firefox\",\nthen only those two browsers would show up as columns.",
+ "type": "array",
+ "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",
+ "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"
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "metric": {
+ "$ref": "MetricHeaderEntry",
+ "description": "The metric header for the metric in the pivot."
+ },
+ "dimensionValues": {
+ "description": "The values for the dimensions in the pivot.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "PivotHeaderEntry"
+ },
+ "SegmentFilter": {
+ "properties": {
+ "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"
+ },
+ "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",
+ "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"
+ },
+ "SegmentDefinition": {
+ "properties": {
+ "segmentFilters": {
+ "description": "A segment is defined by a set of segment filters which are combined\ntogether with a logical `AND` operation.",
+ "type": "array",
+ "items": {
+ "$ref": "SegmentFilter"
+ }
+ }
+ },
+ "id": "SegmentDefinition",
+ "description": "SegmentDefinition defines the segment to be a set of SegmentFilters which\nare combined together with a logical `AND` operation.",
+ "type": "object"
+ },
+ "ResourceQuotasRemaining": {
+ "properties": {
+ "hourlyQuotaTokensRemaining": {
+ "description": "Hourly resource quota tokens remaining.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "dailyQuotaTokensRemaining": {
+ "description": "Daily resource quota remaining remaining.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ResourceQuotasRemaining",
+ "description": "The resource quota tokens remaining for the property after the request is\ncompleted.",
+ "type": "object"
+ },
+ "MetricHeaderEntry": {
+ "properties": {
+ "name": {
+ "description": "The name of the header.",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Metric type is unspecified.",
+ "Integer metric.",
+ "Float metric.",
+ "Currency metric.",
+ "Percentage metric.",
+ "Time metric in `HH:MM:SS` format."
+ ],
+ "enum": [
+ "METRIC_TYPE_UNSPECIFIED",
+ "INTEGER",
+ "FLOAT",
+ "CURRENCY",
+ "PERCENT",
+ "TIME"
+ ],
+ "description": "The type of the metric, for example `INTEGER`.",
+ "type": "string"
+ }
+ },
+ "id": "MetricHeaderEntry",
+ "description": "Header for the metrics.",
+ "type": "object"
+ },
+ "ReportData": {
+ "properties": {
"isDataGolden": {
"description": "Indicates if response to this request is golden or not. Data is\ngolden when the exact same request will not produce any new results if\nasked at a later point in time.",
"type": "boolean"
@@ -69,16 +499,12 @@
}
}
},
- "id": "ReportData"
+ "id": "ReportData",
+ "description": "The data part of the report.",
+ "type": "object"
},
"DimensionFilter": {
- "description": "Dimension filter specifies the filtering options on a dimension.",
- "type": "object",
"properties": {
- "caseSensitive": {
- "description": "Should the match be case sensitive? Default is false.",
- "type": "boolean"
- },
"dimensionName": {
"description": "The dimension to filter on. A DimensionFilter must contain a dimension.",
"type": "string"
@@ -116,17 +542,22 @@
"type": "boolean"
},
"expressions": {
+ "description": "Strings or regular expression to match against. Only the first value of\nthe list is used for comparison unless the operator is `IN_LIST`.\nIf `IN_LIST` operator, then the entire list is used to filter the\ndimensions as explained in the description of the `IN_LIST` operator.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "Strings or regular expression to match against. Only the first value of\nthe list is used for comparison unless the operator is `IN_LIST`.\nIf `IN_LIST` operator, then the entire list is used to filter the\ndimensions as explained in the description of the `IN_LIST` operator."
+ }
+ },
+ "caseSensitive": {
+ "description": "Should the match be case sensitive? Default is false.",
+ "type": "boolean"
}
},
- "id": "DimensionFilter"
+ "id": "DimensionFilter",
+ "description": "Dimension filter specifies the filtering options on a dimension.",
+ "type": "object"
},
"SegmentDimensionFilter": {
- "id": "SegmentDimensionFilter",
"description": "Dimension filter specifies the filtering options on a dimension.",
"type": "object",
"properties": {
@@ -139,7 +570,6 @@
"type": "string"
},
"operator": {
- "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.",
@@ -164,7 +594,8 @@
"NUMERIC_GREATER_THAN",
"NUMERIC_BETWEEN"
],
- "description": "The operator to use to match the dimension with the expressions."
+ "description": "The operator to use to match the dimension with the expressions.",
+ "type": "string"
},
"expressions": {
"description": "The list of expressions, only the first element is used for all operators",
@@ -181,7 +612,23 @@
"description": "Minimum comparison values for `BETWEEN` match type.",
"type": "string"
}
- }
+ },
+ "id": "SegmentDimensionFilter"
+ },
+ "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.",
+ "type": "object",
+ "properties": {
+ "dynamicSegment": {
+ "$ref": "DynamicSegment",
+ "description": "A dynamic segment definition in the request."
+ },
+ "segmentId": {
+ "description": "The segment ID of a built-in or custom segment, for example `gaid::-3`.",
+ "type": "string"
+ }
+ },
+ "id": "Segment"
},
"OrderBy": {
"description": "Specifies the sorting options.",
@@ -206,6 +653,14 @@
"type": "string"
},
"orderType": {
+ "enumDescriptions": [
+ "Unspecified order type will be treated as sort based on value.",
+ "The sort order is based on the value of the chosen column; looks only at\nthe first date range.",
+ "The sort order is based on the difference of the values of the chosen\ncolumn between the first two date ranges. Usable only if there are\nexactly two date ranges.",
+ "The sort order is based on weighted value of the chosen column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe `(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios.",
+ "Histogram order type is applicable only to dimension columns with\nnon-empty histogram-buckets.",
+ "If the dimensions are fixed length numbers, ordinary sort would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions are\nvariable length numbers."
+ ],
"enum": [
"ORDER_TYPE_UNSPECIFIED",
"VALUE",
@@ -215,44 +670,21 @@
"DIMENSION_AS_INTEGER"
],
"description": "The order type. The default orderType is `VALUE`.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified order type will be treated as sort based on value.",
- "The sort order is based on the value of the chosen column; looks only at\nthe first date range.",
- "The sort order is based on the difference of the values of the chosen\ncolumn between the first two date ranges. Usable only if there are\nexactly two date ranges.",
- "The sort order is based on weighted value of the chosen column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe `(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios.",
- "Histogram order type is applicable only to dimension columns with\nnon-empty histogram-buckets.",
- "If the dimensions are fixed length numbers, ordinary sort would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions are\nvariable length numbers."
- ]
+ "type": "string"
}
},
"id": "OrderBy"
},
- "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.",
- "type": "object",
- "properties": {
- "segmentId": {
- "description": "The segment ID of a built-in or custom segment, for example `gaid::-3`.",
- "type": "string"
- },
- "dynamicSegment": {
- "description": "A dynamic segment definition in the request.",
- "$ref": "DynamicSegment"
- }
- },
- "id": "Segment"
- },
"SegmentSequenceStep": {
"description": "A segment sequence definition.",
"type": "object",
"properties": {
"orFiltersForSegment": {
+ "description": "A sequence is specified with a list of Or grouped filters which are\ncombined with `AND` operator.",
"type": "array",
"items": {
"$ref": "OrFiltersForSegment"
- },
- "description": "A sequence is specified with a list of Or grouped filters which are\ncombined with `AND` operator."
+ }
},
"matchType": {
"enumDescriptions": [
@@ -276,6 +708,14 @@
"type": "object",
"properties": {
"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": [
@@ -285,14 +725,6 @@
"Currency metric.",
"Percentage metric.",
"Time metric in `HH:MM:SS` format."
- ],
- "enum": [
- "METRIC_TYPE_UNSPECIFIED",
- "INTEGER",
- "FLOAT",
- "CURRENCY",
- "PERCENT",
- "TIME"
]
},
"alias": {
@@ -300,8 +732,8 @@
"type": "string"
},
"expression": {
- "type": "string",
- "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."
+ "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"
}
},
"id": "Metric"
@@ -311,18 +743,16 @@
"type": "object",
"properties": {
"values": {
+ "description": "The values of the metrics in each of the pivot regions.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "The values of the metrics in each of the pivot regions."
+ }
}
},
"id": "PivotValueRegion"
},
"Report": {
- "description": "The data response corresponding to the request.",
- "type": "object",
"properties": {
"data": {
"description": "Response data.",
@@ -333,11 +763,13 @@
"type": "string"
},
"columnHeader": {
- "$ref": "ColumnHeader",
- "description": "The column headers."
+ "description": "The column headers.",
+ "$ref": "ColumnHeader"
}
},
- "id": "Report"
+ "id": "Report",
+ "description": "The data response corresponding to the request.",
+ "type": "object"
},
"PivotHeader": {
"description": "The headers for each of the pivot sections defined in the request.",
@@ -359,8 +791,6 @@
"id": "PivotHeader"
},
"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`.",
@@ -371,49 +801,23 @@
"type": "string"
}
},
- "id": "DateRange"
- },
- "MetricFilter": {
- "properties": {
- "metricName": {
- "description": "The metric that will be filtered on. A metricFilter must contain a metric\nname. A metric name can be an alias earlier defined as a metric or it can\nalso be a metric expression.",
- "type": "string"
- },
- "comparisonValue": {
- "description": "The value to compare against.",
- "type": "string"
- },
- "operator": {
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "EQUAL",
- "LESS_THAN",
- "GREATER_THAN",
- "IS_MISSING"
- ],
- "description": "Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the\ncomparisonValue, the default is `EQUAL`. If the operator is\n`IS_MISSING`, checks if the metric is missing and would ignore the\ncomparisonValue.",
- "type": "string",
- "enumDescriptions": [
- "If the operator is not specified, it is treated as `EQUAL`.",
- "Should the value of the metric be exactly equal to the comparison value.",
- "Should the value of the metric be less than to the comparison value.",
- "Should the value of the metric be greater than to the comparison value.",
- "Validates if the metric is missing.\nDoesn't take comparisonValue into account."
- ]
- },
- "not": {
- "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\nmetric values will be excluded in the report. The default is false.",
- "type": "boolean"
- }
- },
- "id": "MetricFilter",
- "description": "MetricFilter specifies the filter on a metric.",
+ "id": "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": {
- "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",
@@ -426,21 +830,21 @@
"format": "int32",
"type": "integer"
},
- "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"
},
+ "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"
+ },
"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.",
"$ref": "CohortGroup"
},
"filtersExpression": {
- "type": "string",
- "description": "Dimension or metric filters that restrict the data returned for your\nrequest. To use the `filtersExpression`, supply a dimension or metric on\nwhich to filter, followed by the filter expression. For example, the\nfollowing expression selects `ga:browser` dimension which starts with\nFirefox; `ga:browser=~^Firefox`. For more information on dimensions\nand metric filters, see\n[Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters)."
+ "description": "Dimension or metric filters that restrict the data returned for your\nrequest. To use the `filtersExpression`, supply a dimension or metric on\nwhich to filter, followed by the filter expression. For example, the\nfollowing expression selects `ga:browser` dimension which starts with\nFirefox; `ga:browser=~^Firefox`. For more information on dimensions\nand metric filters, see\n[Filters reference](https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters).",
+ "type": "string"
},
"viewId": {
"description": "The Analytics\n[view ID](https://support.google.com/analytics/answer/1009618)\nfrom which to retrieve data. Every [ReportRequest](#ReportRequest)\nwithin a `batchGet` method must contain the same `viewId`.",
@@ -475,12 +879,6 @@
}
},
"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",
@@ -488,7 +886,13 @@
"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"
+ "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."
+ ]
},
"dimensions": {
"description": "The dimensions requested.\nRequests can have a total of 7 dimensions.",
@@ -507,29 +911,51 @@
"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"
},
- "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",
+ "MetricFilter": {
"properties": {
- "name": {
- "description": "Name of the dimension to fetch, for example `ga:browser`.",
+ "operator": {
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "EQUAL",
+ "LESS_THAN",
+ "GREATER_THAN",
+ "IS_MISSING"
+ ],
+ "description": "Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the\ncomparisonValue, the default is `EQUAL`. If the operator is\n`IS_MISSING`, checks if the metric is missing and would ignore the\ncomparisonValue.",
+ "type": "string",
+ "enumDescriptions": [
+ "If the operator is not specified, it is treated as `EQUAL`.",
+ "Should the value of the metric be exactly equal to the comparison value.",
+ "Should the value of the metric be less than to the comparison value.",
+ "Should the value of the metric be greater than to the comparison value.",
+ "Validates if the metric is missing.\nDoesn't take comparisonValue into account."
+ ]
+ },
+ "not": {
+ "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\nmetric values will be excluded in the report. The default is false.",
+ "type": "boolean"
+ },
+ "metricName": {
+ "description": "The metric that will be filtered on. A metricFilter must contain a metric\nname. A metric name can be an alias earlier defined as a metric or it can\nalso be a metric expression.",
"type": "string"
},
+ "comparisonValue": {
+ "description": "The value to compare against.",
+ "type": "string"
+ }
+ },
+ "id": "MetricFilter",
+ "description": "MetricFilter specifies the filter on a metric.",
+ "type": "object"
+ },
+ "Dimension": {
+ "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.",
"type": "array",
@@ -537,9 +963,15 @@
"format": "int64",
"type": "string"
}
+ },
+ "name": {
+ "description": "Name of the dimension to fetch, for example `ga:browser`.",
+ "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"
},
"SimpleSegment": {
"description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined.",
@@ -556,9 +988,11 @@
"id": "SimpleSegment"
},
"DynamicSegment": {
- "description": "Dynamic segment definition for defining the segment within the request.\nA segment can select users, sessions or both.",
- "type": "object",
"properties": {
+ "sessionSegment": {
+ "$ref": "SegmentDefinition",
+ "description": "Session Segment to select sessions to include in the segment."
+ },
"name": {
"description": "The name of the dynamic segment.",
"type": "string"
@@ -566,17 +1000,13 @@
"userSegment": {
"$ref": "SegmentDefinition",
"description": "User Segment to select users to include in the segment."
- },
- "sessionSegment": {
- "$ref": "SegmentDefinition",
- "description": "Session Segment to select sessions to include in the segment."
}
},
- "id": "DynamicSegment"
+ "id": "DynamicSegment",
+ "description": "Dynamic segment definition for defining the segment within the request.\nA segment can select users, sessions or both.",
+ "type": "object"
},
"ColumnHeader": {
- "description": "Column headers.",
- "type": "object",
"properties": {
"dimensions": {
"description": "The dimension names in the response.",
@@ -586,19 +1016,19 @@
}
},
"metricHeader": {
- "$ref": "MetricHeader",
- "description": "Metric headers for the metrics in the response."
+ "description": "Metric headers for the metrics in the response.",
+ "$ref": "MetricHeader"
}
},
- "id": "ColumnHeader"
+ "id": "ColumnHeader",
+ "description": "Column headers.",
+ "type": "object"
},
"SegmentFilterClause": {
- "description": "Filter Clause to be used in a segment definition, can be wither a metric or\na dimension filter.",
- "type": "object",
"properties": {
"metricFilter": {
- "description": "Metric Filter for the segment definition.",
- "$ref": "SegmentMetricFilter"
+ "$ref": "SegmentMetricFilter",
+ "description": "Metric Filter for the segment definition."
},
"not": {
"description": "Matches the complement (`!`) of the filter.",
@@ -609,443 +1039,9 @@
"$ref": "SegmentDimensionFilter"
}
},
- "id": "SegmentFilterClause"
- },
- "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."
- ]
- },
- "filters": {
- "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
- "type": "array",
- "items": {
- "$ref": "MetricFilter"
- }
- }
- },
- "id": "MetricFilterClause"
- },
- "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.",
- "type": "object",
- "properties": {
- "name": {
- "description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...].",
- "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."
- },
- "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"
- }
- },
- "id": "Cohort"
- },
- "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"
- }
- }
- },
- "id": "ReportRow"
- },
- "OrFiltersForSegment": {
- "properties": {
- "segmentFilterClauses": {
- "description": "List of segment filters to be combined with a `OR` operator.",
- "type": "array",
- "items": {
- "$ref": "SegmentFilterClause"
- }
- }
- },
- "id": "OrFiltersForSegment",
- "description": "A list of segment filters in the `OR` group are combined with the logical OR\noperator.",
+ "id": "SegmentFilterClause",
+ "description": "Filter Clause to be used in a segment definition, can be wither a metric or\na dimension filter.",
"type": "object"
- },
- "MetricHeader": {
- "properties": {
- "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",
- "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": [
- "Unspecified operator. It is treated as an `OR`.",
- "The logical `OR` operator.",
- "The logical `AND` operator."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "OR",
- "AND"
- ],
- "description": "The operator for combining multiple dimension filters. If unspecified, it\nis treated as an `OR`.",
- "type": "string"
- },
- "filters": {
- "description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
- "type": "array",
- "items": {
- "$ref": "DimensionFilter"
- }
- }
- },
- "id": "DimensionFilterClause"
- },
- "GetReportsResponse": {
- "description": "The main response class which holds the reports from the Reporting API\n`batchGet` call.",
- "type": "object",
- "properties": {
- "reports": {
- "description": "Responses corresponding to each of the request.",
- "type": "array",
- "items": {
- "$ref": "Report"
- }
- },
- "queryCost": {
- "type": "integer",
- "description": "The amount of resource quota tokens deducted to execute the query. Includes\nall responses.",
- "format": "int32"
- },
- "resourceQuotasRemaining": {
- "$ref": "ResourceQuotasRemaining",
- "description": "The amount of resource quota remaining for the property."
- }
- },
- "id": "GetReportsResponse"
- },
- "SequenceSegment": {
- "properties": {
- "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",
- "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"
- },
- "SegmentMetricFilter": {
- "properties": {
- "comparisonValue": {
- "description": "The value to compare against. If the operator is `BETWEEN`, this value is\ntreated as minimum comparison value.",
- "type": "string"
- },
- "operator": {
- "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"
- ],
- "description": "Specifies is the operation to perform to compare the metric. The default\nis `EQUAL`."
- },
- "metricName": {
- "description": "The metric that will be filtered on. A `metricFilter` must contain a\nmetric name.",
- "type": "string"
- },
- "scope": {
- "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.",
- "Hit scope.",
- "Session scope.",
- "User scope."
- ],
- "enum": [
- "UNSPECIFIED_SCOPE",
- "PRODUCT",
- "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.",
- "type": "string"
- }
- },
- "id": "SegmentMetricFilter",
- "description": "Metric filter to be used in a segment filter clause.",
- "type": "object"
- },
- "DateRangeValues": {
- "description": "Used to return a list of metrics for a single DateRange / dimension\ncombination",
- "type": "object",
- "properties": {
- "pivotValueRegions": {
- "description": "The values of each pivot region.",
- "type": "array",
- "items": {
- "$ref": "PivotValueRegion"
- }
- },
- "values": {
- "description": "Each value corresponds to each Metric in the request.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "DateRangeValues"
- },
- "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 }",
- "type": "object",
- "properties": {
- "cohorts": {
- "description": "The definition for the cohort.",
- "type": "array",
- "items": {
- "$ref": "Cohort"
- }
- },
- "lifetimeValue": {
- "description": "Enable Life Time Value (LTV). LTV measures lifetime value for users\nacquired through different channels.\nPlease see:\n[Cohort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifetime Value](https://support.google.com/analytics/answer/6182550)\nIf the value of lifetimeValue is false:\n\n- The metric values are similar to the values in the web interface cohort\n report.\n- The cohort definition date ranges must be aligned to the calendar week\n and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in\n the cohort definition should be a Sunday and the `endDate` should be the\n following Saturday, and for `ga:cohortNthMonth`, the `startDate`\n should be the 1st of the month and `endDate` should be the last day\n of the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will correspond to the values in the web interface\n LifeTime value report.\n- The Lifetime Value report shows you how user value (Revenue) and\n engagement (Appviews, Goal Completions, Sessions, and Session Duration)\n grow during the 90 days after a user is acquired.\n- The metrics are calculated as a cumulative average per user per the time\n increment.\n- The cohort definition date ranges need not be aligned to the calendar\n week and month boundaries.\n- The `viewId` must be an\n [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)",
- "type": "boolean"
- }
- },
- "id": "CohortGroup"
- },
- "GetReportsRequest": {
- "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.",
- "type": "boolean"
- },
- "reportRequests": {
- "description": "Requests, each request will have a separate response.\nThere can be a maximum of 5 requests. All requests should have the same\n`dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`.",
- "type": "array",
- "items": {
- "$ref": "ReportRequest"
- }
- }
- },
- "id": "GetReportsRequest",
- "description": "The batch request containing multiple report request."
- },
- "Pivot": {
- "id": "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": {
- "metrics": {
- "description": "The pivot metrics. Pivot metrics are part of the\nrestriction on total number of metrics allowed in the request.",
- "type": "array",
- "items": {
- "$ref": "Metric"
- }
- },
- "dimensions": {
- "description": "A list of dimensions to show as pivot columns. A Pivot can have a maximum\nof 4 dimensions. Pivot dimensions are part of the restriction on the\ntotal number of dimensions allowed in the request.",
- "type": "array",
- "items": {
- "$ref": "Dimension"
- }
- },
- "dimensionFilterClauses": {
- "description": "DimensionFilterClauses are logically combined with an `AND` operator: only\ndata that is included by all these DimensionFilterClauses contributes to\nthe values in this pivot region. Dimension filters can be used to restrict\nthe columns shown in the pivot region. For example if you have\n`ga:browser` as the requested dimension in the pivot region, and you\nspecify key filters to restrict `ga:browser` to only \"IE\" or \"Firefox\",\nthen only those two browsers would show up as columns.",
- "type": "array",
- "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"
- },
- "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",
- "type": "integer"
- }
- }
- },
- "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",
- "properties": {
- "dimensionValues": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The values for the dimensions in the pivot."
- },
- "dimensionNames": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The name of the dimensions in the pivot response."
- },
- "metric": {
- "description": "The metric header for the metric in the pivot.",
- "$ref": "MetricHeaderEntry"
- }
- }
- },
- "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": {
- "simpleSegment": {
- "$ref": "SimpleSegment",
- "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined"
- },
- "sequenceSegment": {
- "$ref": "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."
- },
- "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"
- }
- },
- "id": "SegmentFilter"
- },
- "SegmentDefinition": {
- "type": "object",
- "properties": {
- "segmentFilters": {
- "description": "A segment is defined by a set of segment filters which are combined\ntogether with a logical `AND` operation.",
- "type": "array",
- "items": {
- "$ref": "SegmentFilter"
- }
- }
- },
- "id": "SegmentDefinition",
- "description": "SegmentDefinition defines the segment to be a set of SegmentFilters which\nare combined together with a logical `AND` operation."
- },
- "MetricHeaderEntry": {
- "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.",
- "Float metric.",
- "Currency metric.",
- "Percentage metric.",
- "Time metric in `HH:MM:SS` format."
- ],
- "enum": [
- "METRIC_TYPE_UNSPECIFIED",
- "INTEGER",
- "FLOAT",
- "CURRENCY",
- "PERCENT",
- "TIME"
- ]
- }
- },
- "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.",
- "format": "int32",
- "type": "integer"
- },
- "dailyQuotaTokensRemaining": {
- "description": "Daily resource quota remaining remaining.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ResourceQuotasRemaining"
}
},
"icons": {
@@ -1076,102 +1072,68 @@
"reports": {
"methods": {
"batchGet": {
+ "description": "Returns the Analytics data.",
"request": {
"$ref": "GetReportsRequest"
},
- "description": "Returns the Analytics data.",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "GetReportsResponse"
},
- "parameters": {},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/analytics",
"https://www.googleapis.com/auth/analytics.readonly"
],
+ "parameters": {},
"flatPath": "v4/reports:batchGet",
- "id": "analyticsreporting.reports.batchGet",
- "path": "v4/reports:batchGet"
+ "path": "v4/reports:batchGet",
+ "id": "analyticsreporting.reports.batchGet"
}
}
}
},
"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": {
- "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": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ "location": "query"
},
"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"
},
+ "$.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": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
"alt": {
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -1182,12 +1144,50 @@
"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": {
+ "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"
}
},
"version": "v4",
"baseUrl": "https://analyticsreporting.googleapis.com/",
- "kind": "discovery#restDescription",
+ "servicePath": "",
"description": "Accesses Analytics report data.",
- "servicePath": ""
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "revision": "20171108",
+ "documentationLink": "https://developers.google.com/analytics/devguides/reporting/core/v4/",
+ "id": "analyticsreporting:v4"
}
diff --git a/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json b/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
index ce8206b..e5a88e4 100644
--- a/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
+++ b/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
@@ -1,4 +1,7 @@
{
+ "version": "v1",
+ "baseUrl": "https://androiddeviceprovisioning.googleapis.com/",
+ "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": "",
@@ -17,61 +20,13 @@
"resources": {
"partners": {
"resources": {
- "customers": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "partnerId"
- ],
- "response": {
- "$ref": "ListCustomersResponse"
- },
- "parameters": {
- "partnerId": {
- "pattern": "^[^/]+$",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the partner."
- }
- },
- "flatPath": "v1/partners/{partnersId}/customers",
- "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."
- },
- "create": {
- "id": "androiddeviceprovisioning.partners.customers.create",
- "path": "v1/{+parent}/customers",
- "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": {
- "pattern": "^partners/[^/]+$",
- "location": "path",
- "description": "Required. The parent resource ID in the format `partners/[PARTNER_ID]` that\nidentifies the reseller.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/partners/{partnersId}/customers"
- }
- }
- },
"devices": {
"methods": {
"updateMetadataAsync": {
+ "description": "Set metadata in batch asynchronously.",
+ "request": {
+ "$ref": "UpdateDeviceMetadataInBatchRequest"
+ },
"response": {
"$ref": "Operation"
},
@@ -81,21 +36,17 @@
"httpMethod": "POST",
"parameters": {
"partnerId": {
+ "description": "Partner ID.",
+ "pattern": "^[^/]+$",
"format": "int64",
"required": true,
"type": "string",
- "location": "path",
- "description": "Partner ID.",
- "pattern": "^[^/]+$"
+ "location": "path"
}
},
"flatPath": "v1/partners/{partnersId}/devices:updateMetadataAsync",
"path": "v1/partners/{+partnerId}/devices:updateMetadataAsync",
- "id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync",
- "description": "Set metadata in batch asynchronously.",
- "request": {
- "$ref": "UpdateDeviceMetadataInBatchRequest"
- }
+ "id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync"
},
"get": {
"description": "Get a device.",
@@ -108,11 +59,11 @@
],
"parameters": {
"name": {
+ "location": "path",
"description": "Resource name in `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.",
"required": true,
"type": "string",
- "pattern": "^partners/[^/]+/devices/[^/]+$",
- "location": "path"
+ "pattern": "^partners/[^/]+/devices/[^/]+$"
}
},
"flatPath": "v1/partners/{partnersId}/devices/{devicesId}",
@@ -120,8 +71,6 @@
"path": "v1/{+name}"
},
"unclaim": {
- "path": "v1/partners/{+partnerId}/devices:unclaim",
- "id": "androiddeviceprovisioning.partners.devices.unclaim",
"request": {
"$ref": "UnclaimDeviceRequest"
},
@@ -135,17 +84,26 @@
"httpMethod": "POST",
"parameters": {
"partnerId": {
+ "description": "ID of the partner.",
"pattern": "^[^/]+$",
"format": "int64",
"required": true,
"type": "string",
- "location": "path",
- "description": "ID of the partner."
+ "location": "path"
}
},
- "flatPath": "v1/partners/{partnersId}/devices:unclaim"
+ "flatPath": "v1/partners/{partnersId}/devices:unclaim",
+ "path": "v1/partners/{+partnerId}/devices:unclaim",
+ "id": "androiddeviceprovisioning.partners.devices.unclaim"
},
"findByOwner": {
+ "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.",
"httpMethod": "POST",
"parameterOrder": [
"partnerId"
@@ -155,30 +113,16 @@
},
"parameters": {
"partnerId": {
- "location": "path",
- "description": "ID of the partner.",
- "pattern": "^[^/]+$",
"format": "int64",
"type": "string",
- "required": true
+ "required": true,
+ "location": "path",
+ "description": "ID of the partner.",
+ "pattern": "^[^/]+$"
}
- },
- "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": {
- "flatPath": "v1/partners/{partnersId}/devices:claim",
- "id": "androiddeviceprovisioning.partners.devices.claim",
- "path": "v1/partners/{+partnerId}/devices:claim",
- "request": {
- "$ref": "ClaimDeviceRequest"
- },
- "description": "Claim the device identified by device identifier.",
"httpMethod": "POST",
"parameterOrder": [
"partnerId"
@@ -188,22 +132,23 @@
},
"parameters": {
"partnerId": {
- "pattern": "^[^/]+$",
"format": "int64",
"required": true,
"type": "string",
"location": "path",
- "description": "ID of the partner."
+ "description": "ID of the partner.",
+ "pattern": "^[^/]+$"
}
- }
+ },
+ "flatPath": "v1/partners/{partnersId}/devices:claim",
+ "id": "androiddeviceprovisioning.partners.devices.claim",
+ "path": "v1/partners/{+partnerId}/devices:claim",
+ "request": {
+ "$ref": "ClaimDeviceRequest"
+ },
+ "description": "Claim the device identified by device identifier."
},
"claimAsync": {
- "path": "v1/partners/{+partnerId}/devices:claimAsync",
- "id": "androiddeviceprovisioning.partners.devices.claimAsync",
- "request": {
- "$ref": "ClaimDevicesRequest"
- },
- "description": "Claim devices asynchronously.",
"response": {
"$ref": "Operation"
},
@@ -213,21 +158,23 @@
"httpMethod": "POST",
"parameters": {
"partnerId": {
- "format": "int64",
- "type": "string",
- "required": true,
"location": "path",
"description": "Partner ID.",
- "pattern": "^[^/]+$"
+ "pattern": "^[^/]+$",
+ "format": "int64",
+ "type": "string",
+ "required": true
}
},
- "flatPath": "v1/partners/{partnersId}/devices:claimAsync"
+ "flatPath": "v1/partners/{partnersId}/devices:claimAsync",
+ "path": "v1/partners/{+partnerId}/devices:claimAsync",
+ "id": "androiddeviceprovisioning.partners.devices.claimAsync",
+ "request": {
+ "$ref": "ClaimDevicesRequest"
+ },
+ "description": "Claim devices asynchronously."
},
"findByIdentifier": {
- "request": {
- "$ref": "FindDevicesByDeviceIdentifierRequest"
- },
- "description": "Find devices by device identifier.",
"response": {
"$ref": "FindDevicesByDeviceIdentifierResponse"
},
@@ -247,9 +194,14 @@
},
"flatPath": "v1/partners/{partnersId}/devices:findByIdentifier",
"path": "v1/partners/{+partnerId}/devices:findByIdentifier",
- "id": "androiddeviceprovisioning.partners.devices.findByIdentifier"
+ "id": "androiddeviceprovisioning.partners.devices.findByIdentifier",
+ "request": {
+ "$ref": "FindDevicesByDeviceIdentifierRequest"
+ },
+ "description": "Find devices by device identifier."
},
"unclaimAsync": {
+ "flatPath": "v1/partners/{partnersId}/devices:unclaimAsync",
"id": "androiddeviceprovisioning.partners.devices.unclaimAsync",
"path": "v1/partners/{+partnerId}/devices:unclaimAsync",
"request": {
@@ -265,15 +217,14 @@
},
"parameters": {
"partnerId": {
+ "location": "path",
"description": "Partner ID.",
"pattern": "^[^/]+$",
"format": "int64",
"type": "string",
- "required": true,
- "location": "path"
+ "required": true
}
- },
- "flatPath": "v1/partners/{partnersId}/devices:unclaimAsync"
+ }
},
"metadata": {
"request": {
@@ -289,21 +240,21 @@
],
"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"
- },
"deviceId": {
- "description": "ID of the partner.",
"pattern": "^[^/]+$",
"format": "int64",
"type": "string",
"required": true,
- "location": "path"
+ "location": "path",
+ "description": "ID of the partner."
+ },
+ "metadataOwnerId": {
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The owner of the newly set metadata. Set this to the partner ID.",
+ "pattern": "^[^/]+$"
}
},
"flatPath": "v1/partners/{partnersId}/devices/{devicesId}/metadata",
@@ -311,6 +262,58 @@
"id": "androiddeviceprovisioning.partners.devices.metadata"
}
}
+ },
+ "customers": {
+ "methods": {
+ "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": {
+ "description": "Required. The parent resource ID in the format `partners/[PARTNER_ID]` that\nidentifies the reseller.",
+ "required": true,
+ "type": "string",
+ "pattern": "^partners/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/partners/{partnersId}/customers",
+ "id": "androiddeviceprovisioning.partners.customers.create",
+ "path": "v1/{+parent}/customers"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "partnerId"
+ ],
+ "response": {
+ "$ref": "ListCustomersResponse"
+ },
+ "parameters": {
+ "partnerId": {
+ "description": "The ID of the partner.",
+ "pattern": "^[^/]+$",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/partners/{partnersId}/customers",
+ "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."
+ }
+ }
}
}
},
@@ -342,22 +345,11 @@
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"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\").",
@@ -377,9 +369,9 @@
"type": "string"
},
"callback": {
- "location": "query",
"description": "JSONP",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"alt": {
"enum": [
@@ -403,20 +395,20 @@
"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"
},
"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"
+ "default": "true",
+ "location": "query"
},
"oauth_token": {
"location": "query",
@@ -424,136 +416,26 @@
"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": {
- "UpdateDeviceMetadataRequest": {
- "description": "Request to set metadata for a device.",
- "type": "object",
- "properties": {
- "deviceMetadata": {
- "$ref": "DeviceMetadata",
- "description": "The metdata to set."
- }
- },
- "id": "UpdateDeviceMetadataRequest"
- },
- "PartnerUnclaim": {
- "description": "Identifies one unclaim request.",
- "type": "object",
- "properties": {
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "Device identifier of the device."
- },
- "sectionType": {
- "description": "Section type to unclaim.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero-touch enrollment section type."
- ],
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ]
- },
- "deviceId": {
- "description": "Device ID of the device.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "PartnerUnclaim"
- },
- "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"
- },
- "FindDevicesByDeviceIdentifierResponse": {
- "description": "Response containing found devices.",
- "type": "object",
- "properties": {
- "devices": {
- "description": "Found devices.",
- "type": "array",
- "items": {
- "$ref": "Device"
- }
- },
- "nextPageToken": {
- "description": "Page token of the next page.",
- "type": "string"
- }
- },
- "id": "FindDevicesByDeviceIdentifierResponse"
- },
- "PartnerClaim": {
- "description": "Identifies one claim request.",
- "type": "object",
- "properties": {
- "deviceIdentifier": {
- "description": "Device identifier of the device.",
- "$ref": "DeviceIdentifier"
- },
- "deviceMetadata": {
- "$ref": "DeviceMetadata",
- "description": "Metadata to set at claim."
- },
- "sectionType": {
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "Section type to claim.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero-touch enrollment section type."
- ]
- },
- "customerId": {
- "description": "Customer ID to claim for.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "PartnerClaim"
- },
- "UnclaimDeviceRequest": {
- "properties": {
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "The device identifier you used when you claimed this device."
- },
- "sectionType": {
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero-touch enrollment section type."
- ],
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "The section type to unclaim for.",
- "type": "string"
- },
- "deviceId": {
- "description": "The device ID returned by `ClaimDevice`.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "UnclaimDeviceRequest",
- "description": "Request message to unclaim a device.",
- "type": "object"
- },
"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": {
"additionalProperties": {
@@ -563,9 +445,7 @@
"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).",
- "type": "object"
+ "id": "DeviceMetadata"
},
"DevicesLongRunningOperationResponse": {
"description": "Long running operation response.",
@@ -590,21 +470,21 @@
"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": {
+ "description": "The ID of the Customer that purchased the device.",
+ "format": "int64",
+ "type": "string"
+ },
"sectionType": {
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
"enum": [
"SECTION_TYPE_UNSPECIFIED",
"SECTION_TYPE_ZERO_TOUCH"
],
"description": "Output only. The type of claim made on the device.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero-touch enrollment section type."
- ]
- },
- "ownerCompanyId": {
- "description": "The ID of the Customer that purchased the device.",
- "format": "int64",
"type": "string"
}
},
@@ -614,6 +494,11 @@
"description": "Stores the processing result for each device.",
"type": "object",
"properties": {
+ "deviceId": {
+ "description": "Device ID of the device if process succeeds.",
+ "format": "int64",
+ "type": "string"
+ },
"status": {
"enumDescriptions": [
"Invalid code. Shouldn't be used.",
@@ -645,16 +530,13 @@
"errorMessage": {
"description": "Error message.",
"type": "string"
- },
- "deviceId": {
- "description": "Device ID of the device if process succeeds.",
- "format": "int64",
- "type": "string"
}
},
"id": "PerDeviceStatusInBatch"
},
"ClaimDevicesRequest": {
+ "description": "Request to claim devices asynchronously in batch.",
+ "type": "object",
"properties": {
"claims": {
"description": "List of claims.",
@@ -664,14 +546,28 @@
}
}
},
- "id": "ClaimDevicesRequest",
- "description": "Request to claim devices asynchronously in batch.",
- "type": "object"
+ "id": "ClaimDevicesRequest"
},
"FindDevicesByOwnerRequest": {
"description": "Request to find devices by customers.",
"type": "object",
"properties": {
+ "pageToken": {
+ "description": "Page token.",
+ "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",
@@ -684,22 +580,6 @@
"description": "The number of devices to show in the result.",
"format": "int64",
"type": "string"
- },
- "pageToken": {
- "description": "Page token.",
- "type": "string"
- },
- "sectionType": {
- "enum": [
- "SECTION_TYPE_UNSPECIFIED",
- "SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "The section type.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified section type.",
- "Zero-touch enrollment section type."
- ]
}
},
"id": "FindDevicesByOwnerRequest"
@@ -708,10 +588,6 @@
"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.",
@@ -729,20 +605,26 @@
"description": "This field will always be not set if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`. In this case, error information for each device is set in `response.perDeviceStatus.result.status`."
},
"metadata": {
+ "description": "This field will contain a `DevicesLongRunningOperationMetadata` 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"
- },
- "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"
}
},
"id": "Operation"
},
"DeviceIdentifier": {
- "description": "Encapsulates hardware and product IDs to identify a manufactured device. To\nlearn more, read [Identifiers](/zero-touch/guides/identifiers).",
- "type": "object",
"properties": {
+ "imei": {
+ "description": "The device’s IMEI number. Validated on input.",
+ "type": "string"
+ },
"meid": {
"description": "The device’s MEID number.",
"type": "string"
@@ -754,13 +636,11 @@
"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": "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"
},
"UnclaimDevicesRequest": {
"description": "Request to unclaim devices asynchronously in batch.",
@@ -777,31 +657,29 @@
"id": "UnclaimDevicesRequest"
},
"FindDevicesByDeviceIdentifierRequest": {
+ "description": "Request to find devices.",
+ "type": "object",
"properties": {
- "deviceIdentifier": {
- "$ref": "DeviceIdentifier",
- "description": "The device identifier to search."
- },
- "pageToken": {
- "description": "Page token.",
- "type": "string"
- },
"limit": {
"description": "Number of devices to show.",
"format": "int64",
"type": "string"
+ },
+ "deviceIdentifier": {
+ "description": "The device identifier to search.",
+ "$ref": "DeviceIdentifier"
+ },
+ "pageToken": {
+ "description": "Page token.",
+ "type": "string"
}
},
- "id": "FindDevicesByDeviceIdentifierRequest",
- "description": "Request to find devices.",
- "type": "object"
+ "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": {
- "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",
@@ -817,34 +695,36 @@
"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"
},
"OperationPerDevice": {
+ "description": "Operation the server received for every device.",
+ "type": "object",
"properties": {
+ "updateMetadata": {
+ "$ref": "UpdateMetadataArguments",
+ "description": "Request to set metadata for a device."
+ },
"unclaim": {
"$ref": "PartnerUnclaim",
"description": "Request to unclaim a device."
},
"result": {
- "description": "Processing result for every device.",
- "$ref": "PerDeviceStatusInBatch"
+ "$ref": "PerDeviceStatusInBatch",
+ "description": "Processing result for every device."
},
"claim": {
- "description": "Request to claim a device.",
- "$ref": "PartnerClaim"
- },
- "updateMetadata": {
- "description": "Request to set metadata for a device.",
- "$ref": "UpdateMetadataArguments"
+ "$ref": "PartnerClaim",
+ "description": "Request to claim a device."
}
},
- "id": "OperationPerDevice",
- "description": "Operation the server received for every device.",
- "type": "object"
+ "id": "OperationPerDevice"
},
"FindDevicesByOwnerResponse": {
"description": "Response containing found devices.",
@@ -873,6 +753,8 @@
"description": "The device identifier of the device to claim."
},
"sectionType": {
+ "description": "The section to claim.",
+ "type": "string",
"enumDescriptions": [
"Unspecified section type.",
"Zero-touch enrollment section type."
@@ -880,9 +762,7 @@
"enum": [
"SECTION_TYPE_UNSPECIFIED",
"SECTION_TYPE_ZERO_TOUCH"
- ],
- "description": "The section to claim.",
- "type": "string"
+ ]
},
"customerId": {
"description": "The customer to claim for.",
@@ -896,14 +776,7 @@
"description": "Long running operation metadata.",
"type": "object",
"properties": {
- "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.",
@@ -915,17 +788,26 @@
"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"
},
"UpdateDeviceMetadataInBatchRequest": {
+ "description": "Request to update device metadata in batch.",
+ "type": "object",
"properties": {
"updates": {
"description": "List of metadata updates.",
@@ -935,9 +817,7 @@
}
}
},
- "id": "UpdateDeviceMetadataInBatchRequest",
- "description": "Request to update device metadata in batch.",
- "type": "object"
+ "id": "UpdateDeviceMetadataInBatchRequest"
},
"ListCustomersResponse": {
"description": "Response message of all customers related to this partner.",
@@ -954,8 +834,6 @@
"id": "ListCustomersResponse"
},
"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]`.",
@@ -967,17 +845,21 @@
"type": "string"
}
},
- "id": "ClaimDeviceResponse"
+ "id": "ClaimDeviceResponse",
+ "description": "Response message containing device id of the claim.",
+ "type": "object"
},
"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."
+ "description": "The metadata to update.",
+ "$ref": "DeviceMetadata"
},
"deviceId": {
"description": "Device ID of the device.",
@@ -985,17 +867,26 @@
"type": "string"
}
},
- "id": "UpdateMetadataArguments",
- "description": "Identifies metdata updates to one device.",
- "type": "object"
+ "id": "UpdateMetadataArguments"
},
"Device": {
"description": "An Android device registered for zero-touch enrollment.",
"type": "object",
"properties": {
+ "configuration": {
+ "description": "Not available to resellers.",
+ "type": "string"
+ },
+ "claims": {
+ "description": "Output only. The provisioning claims for a device. Devices claimed for\nzero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`.\nCall\n`partners.devices.unclaim`\nor\n`partners.devices.unclaimAsync`\nto remove the device from zero-touch enrollment.",
+ "type": "array",
+ "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)."
+ "description": "The hardware IDs that identify a manufactured device. To learn more, read\n[Identifiers](/zero-touch/guides/identifiers).",
+ "$ref": "DeviceIdentifier"
},
"deviceMetadata": {
"description": "The metadata attached to the device. Structured as key-value pairs. To\nlearn more, read [Device metadata](/zero-touch/guides/metadata).",
@@ -1009,31 +900,20 @@
"description": "Output only. The ID of the device. Assigned by the server.",
"format": "int64",
"type": "string"
- },
- "configuration": {
- "description": "Not available to resellers.",
- "type": "string"
- },
- "claims": {
- "description": "Output only. The provisioning claims for a device. Devices claimed for\nzero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`.\nCall\n`partners.devices.unclaim`\nor\n`partners.devices.unclaimAsync`\nto remove the device from zero-touch enrollment.",
- "type": "array",
- "items": {
- "$ref": "DeviceClaim"
- }
}
},
"id": "Device"
},
"CreateCustomerRequest": {
+ "description": "Request message to create a customer.",
+ "type": "object",
"properties": {
"customer": {
- "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.",
- "$ref": "Company"
+ "$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": {
"description": "A customer resource in the zero-touch enrollment API.",
@@ -1068,14 +948,134 @@
}
},
"id": "Company"
+ },
+ "UpdateDeviceMetadataRequest": {
+ "description": "Request to set metadata for a device.",
+ "type": "object",
+ "properties": {
+ "deviceMetadata": {
+ "description": "The metdata to set.",
+ "$ref": "DeviceMetadata"
+ }
+ },
+ "id": "UpdateDeviceMetadataRequest"
+ },
+ "PartnerUnclaim": {
+ "description": "Identifies one unclaim request.",
+ "type": "object",
+ "properties": {
+ "deviceId": {
+ "description": "Device ID of the device.",
+ "format": "int64",
+ "type": "string"
+ },
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "Device identifier of the device."
+ },
+ "sectionType": {
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "description": "Section type to unclaim.",
+ "type": "string"
+ }
+ },
+ "id": "PartnerUnclaim"
+ },
+ "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"
+ },
+ "FindDevicesByDeviceIdentifierResponse": {
+ "description": "Response containing found devices.",
+ "type": "object",
+ "properties": {
+ "devices": {
+ "description": "Found devices.",
+ "type": "array",
+ "items": {
+ "$ref": "Device"
+ }
+ },
+ "nextPageToken": {
+ "description": "Page token of the next page.",
+ "type": "string"
+ }
+ },
+ "id": "FindDevicesByDeviceIdentifierResponse"
+ },
+ "PartnerClaim": {
+ "description": "Identifies one claim request.",
+ "type": "object",
+ "properties": {
+ "customerId": {
+ "description": "Customer ID to claim for.",
+ "format": "int64",
+ "type": "string"
+ },
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "Device identifier of the device."
+ },
+ "deviceMetadata": {
+ "description": "Metadata to set at claim.",
+ "$ref": "DeviceMetadata"
+ },
+ "sectionType": {
+ "description": "Section type to claim.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ]
+ }
+ },
+ "id": "PartnerClaim"
+ },
+ "UnclaimDeviceRequest": {
+ "description": "Request message to unclaim a device.",
+ "type": "object",
+ "properties": {
+ "deviceIdentifier": {
+ "$ref": "DeviceIdentifier",
+ "description": "The device identifier you used when you claimed this device."
+ },
+ "sectionType": {
+ "enumDescriptions": [
+ "Unspecified section type.",
+ "Zero-touch enrollment section type."
+ ],
+ "enum": [
+ "SECTION_TYPE_UNSPECIFIED",
+ "SECTION_TYPE_ZERO_TOUCH"
+ ],
+ "description": "The section type to unclaim for.",
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "The device ID returned by `ClaimDevice`.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "UnclaimDeviceRequest"
}
},
"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",
- "baseUrl": "https://androiddeviceprovisioning.googleapis.com/",
- "canonicalName": "Android Provisioning Partner"
+ "protocol": "rest"
}
diff --git a/appengine/v1/appengine-api.json b/appengine/v1/appengine-api.json
index 877c742..81fdf14 100644
--- a/appengine/v1/appengine-api.json
+++ b/appengine/v1/appengine-api.json
@@ -1,31 +1,12 @@
{
- "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",
- "id": "appengine:v1",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
"revision": "20171213",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "id": "appengine:v1",
"title": "Google App Engine Admin API",
"discoveryVersion": "v1",
"ownerName": "Google",
@@ -33,84 +14,27 @@
"resources": {
"apps": {
"methods": {
- "get": {
- "path": "v1/apps/{appsId}",
- "id": "appengine.apps.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": {
- "location": "path",
- "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/apps/{appsId}"
- },
- "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"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "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 Application resource to update. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/apps/{appsId}",
- "path": "v1/apps/{appsId}",
- "id": "appengine.apps.patch"
- },
"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"
},
- "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"
},
- "parameters": {},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {},
"flatPath": "v1/apps",
- "id": "appengine.apps.create",
- "path": "v1/apps"
+ "path": "v1/apps",
+ "id": "appengine.apps.create"
},
"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"
@@ -133,867 +57,77 @@
"location": "path"
}
},
- "flatPath": "v1/apps/{appsId}:repair",
- "path": "v1/apps/{appsId}:repair",
- "id": "appengine.apps.repair"
+ "flatPath": "v1/apps/{appsId}:repair"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "Application"
+ },
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
+ "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}",
+ "id": "appengine.apps.get",
+ "path": "v1/apps/{appsId}",
+ "description": "Gets information about an application."
+ },
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "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 Application resource to update. Example: apps/myapp.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}",
+ "path": "v1/apps/{appsId}",
+ "id": "appengine.apps.patch",
+ "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"
+ }
}
},
"resources": {
- "firewall": {
- "resources": {
- "ingressRules": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- },
- "ingressRulesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.delete",
- "description": "Deletes the specified firewall rule."
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListIngressRulesResponse"
- },
- "parameters": {
- "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"
- },
- "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"
- }
- },
- "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",
- "id": "appengine.apps.firewall.ingressRules.list",
- "path": "v1/apps/{appsId}/firewall/ingressRules",
- "description": "Lists the firewall rules of an application."
- },
- "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": {
- "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": "v1/apps/{appsId}/firewall/ingressRules"
- },
- "get": {
- "description": "Gets the specified firewall rule.",
- "response": {
- "$ref": "FirewallRule"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "httpMethod": "GET",
- "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": {
- "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}/firewall/ingressRules/{ingressRulesId}",
- "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.get"
- },
- "patch": {
- "request": {
- "$ref": "FirewallRule"
- },
- "description": "Updates the specified firewall rule.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "response": {
- "$ref": "FirewallRule"
- },
- "parameters": {
- "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"
- },
- "updateMask": {
- "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"
- ],
- "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.patch",
- "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}"
- },
- "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": {
- "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": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate",
- "path": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate",
- "id": "appengine.apps.firewall.ingressRules.batchUpdate"
- }
- }
- }
- }
- },
- "locations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "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": {
- "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,
- "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"
- }
- },
- "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": {
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "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"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Resource name for the location.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/apps/{appsId}/locations/{locationsId}",
- "path": "v1/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get"
- }
- }
- },
- "authorizedCertificates": {
- "methods": {
- "list": {
- "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": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ],
- "description": "Controls the set of fields returned in the LIST response.",
- "type": "string"
- }
- },
- "flatPath": "v1/apps/{appsId}/authorizedCertificates"
- },
- "get": {
- "description": "Gets the specified SSL certificate.",
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "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`.",
- "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}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.get"
- },
- "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": {
- "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"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.patch"
- },
- "create": {
- "path": "v1/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.create",
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "Uploads the specified SSL certificate.",
- "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": "v1/apps/{appsId}/authorizedCertificates"
- },
- "delete": {
- "id": "appengine.apps.authorizedCertificates.delete",
- "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "description": "Deletes the specified SSL certificate.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
- }
- }
- },
"services": {
- "methods": {
- "delete": {
- "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",
- "description": "Deletes the specified service and all enclosed versions."
- },
- "list": {
- "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": {
- "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"
- }
- },
- "flatPath": "v1/apps/{appsId}/services",
- "path": "v1/apps/{appsId}/services",
- "id": "appengine.apps.services.list",
- "description": "Lists all the services in the application."
- },
- "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": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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",
- "description": "Updates the configuration of the specified service.",
- "request": {
- "$ref": "Service"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- }
- },
"resources": {
"versions": {
- "methods": {
- "create": {
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create",
- "path": "v1/apps/{appsId}/services/{servicesId}/versions",
- "request": {
- "$ref": "Version"
- },
- "description": "Deploys code and resource files to a new version.",
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "delete": {
- "path": "v1/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": {
- "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.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
- },
- "list": {
- "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.",
- "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": {
- "appsId": {
- "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
- "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"
- },
- "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,
- "type": "string",
- "location": "path"
- }
- }
- },
- "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"
- },
- "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": {
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the Get response.",
- "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.",
- "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.get"
- },
- "patch": {
- "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": {
- "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`.",
- "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",
- "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."
- }
- },
"resources": {
"instances": {
"methods": {
"delete": {
+ "description": "Stops a running instance.",
"response": {
"$ref": "Operation"
},
@@ -1004,13 +138,10 @@
"instancesId"
],
"httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "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`.",
@@ -1018,25 +149,27 @@
"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"
+ "type": "string",
+ "location": "path"
},
"instancesId": {
"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"
}
},
- "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",
- "description": "Stops a running instance."
+ "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).",
@@ -1055,34 +188,34 @@
"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": {
+ "location": "path",
+ "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
+ "required": true,
+ "type": "string"
+ },
+ "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",
- "location": "query"
+ "type": "integer"
},
"versionsId": {
"location": "path",
"description": "Part of `parent`. See documentation of `appsId`.",
"required": true,
"type": "string"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "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"
}
},
"flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
@@ -1101,46 +234,46 @@
"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"
- ],
"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"
+ "type": "string",
+ "location": "path"
},
"instancesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"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"
}
},
+ "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"
},
"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"
},
@@ -1151,25 +284,28 @@
"instancesId"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"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": {
- "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"
},
+ "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`.",
@@ -1177,25 +313,274 @@
"type": "string"
}
},
- "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"
}
}
}
+ },
+ "methods": {
+ "list": {
+ "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.",
+ "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": {
+ "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": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the List 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"
+ ]
+ },
+ "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",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "response": {
+ "$ref": "Version"
+ },
+ "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"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the Get 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/{versionsId}",
+ "id": "appengine.apps.services.versions.get",
+ "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
+ },
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "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.",
+ "request": {
+ "$ref": "Version"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "POST",
+ "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": {
+ "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"
+ }
+ }
+ },
+ "delete": {
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "path": "v1/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",
+ "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.",
+ "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"
+ ]
+ }
}
}
- }
- },
- "authorizedDomains": {
+ },
"methods": {
- "list": {
- "description": "Lists all domains the user is authorized to administer.",
+ "delete": {
+ "description": "Deletes the specified service and all enclosed versions.",
+ "httpMethod": "DELETE",
"response": {
- "$ref": "ListAuthorizedDomainsResponse"
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "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"
+ ],
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.delete",
+ "path": "v1/apps/{appsId}/services/{servicesId}"
+ },
+ "list": {
+ "description": "Lists all the services in the application.",
+ "response": {
+ "$ref": "ListServicesResponse"
},
"parameterOrder": [
"appsId"
@@ -1203,10 +588,10 @@
"httpMethod": "GET",
"parameters": {
"appsId": {
+ "location": "path",
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"pageToken": {
"location": "query",
@@ -1225,18 +610,134 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
+ "flatPath": "v1/apps/{appsId}/services",
+ "path": "v1/apps/{appsId}/services",
+ "id": "appengine.apps.services.list"
+ },
+ "get": {
+ "description": "Gets the current configuration of the specified service.",
+ "response": {
+ "$ref": "Service"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "GET",
+ "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/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"
+ },
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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/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"
+ },
+ "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.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/apps/{appsId}/services/{servicesId}",
+ "path": "v1/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.patch",
+ "description": "Updates the configuration of the specified service.",
+ "request": {
+ "$ref": "Service"
+ }
+ }
+ }
+ },
+ "authorizedDomains": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListAuthorizedDomainsResponse"
+ },
+ "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"
+ ],
"flatPath": "v1/apps/{appsId}/authorizedDomains",
+ "id": "appengine.apps.authorizedDomains.list",
"path": "v1/apps/{appsId}/authorizedDomains",
- "id": "appengine.apps.authorizedDomains.list"
+ "description": "Lists all domains the user is authorized to administer."
}
}
},
"operations": {
"methods": {
"list": {
- "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.",
"response": {
"$ref": "ListOperationsResponse"
@@ -1251,11 +752,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 name of the operation's parent resource.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"pageToken": {
"location": "query",
@@ -1267,16 +773,15 @@
"description": "The standard list page size.",
"format": "int32",
"type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
}
- }
+ },
+ "flatPath": "v1/apps/{appsId}/operations",
+ "path": "v1/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list"
},
"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"
},
@@ -1284,19 +789,18 @@
"appsId",
"operationsId"
],
- "httpMethod": "GET",
"parameters": {
- "operationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
"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"
}
},
"scopes": [
@@ -1305,15 +809,14 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/apps/{appsId}/operations/{operationsId}",
- "path": "v1/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get"
+ "id": "appengine.apps.operations.get",
+ "path": "v1/apps/{appsId}/operations/{operationsId}"
}
}
},
"domainMappings": {
"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.",
"response": {
"$ref": "Operation"
},
@@ -1330,10 +833,10 @@
"type": "string"
},
"domainMappingsId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -1341,25 +844,20 @@
],
"flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
"path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.delete"
+ "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": {
- "flatPath": "v1/apps/{appsId}/domainMappings",
- "path": "v1/apps/{appsId}/domainMappings",
"id": "appengine.apps.domainMappings.list",
+ "path": "v1/apps/{appsId}/domainMappings",
"description": "Lists the domain mappings on an application.",
- "response": {
- "$ref": "ListDomainMappingsResponse"
- },
+ "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": "ListDomainMappingsResponse"
+ },
"parameters": {
"appsId": {
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
@@ -1378,13 +876,15 @@
"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}/domainMappings"
},
"get": {
- "id": "appengine.apps.domainMappings.get",
- "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
- "description": "Gets the specified domain mapping.",
- "httpMethod": "GET",
"response": {
"$ref": "DomainMapping"
},
@@ -1392,6 +892,12 @@
"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": {
"appsId": {
"location": "path",
@@ -1400,18 +906,16 @@
"type": "string"
},
"domainMappingsId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
+ "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}/domainMappings/{domainMappingsId}"
+ "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.get",
+ "description": "Gets the specified domain mapping."
},
"patch": {
"request": {
@@ -1428,22 +932,22 @@
},
"parameters": {
"updateMask": {
+ "location": "query",
"description": "Standard field mask for the set of fields to be updated.",
"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/domainMappings/example.com.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"domainMappingsId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -1491,59 +995,526 @@
"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": {
+ "get": {
+ "description": "Gets the specified firewall rule.",
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "ingressRulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
+ "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}/firewall/ingressRules/{ingressRulesId}",
+ "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.get"
+ },
+ "patch": {
+ "request": {
+ "$ref": "FirewallRule"
+ },
+ "description": "Updates the specified firewall rule.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "parameters": {
+ "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 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": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
+ "id": "appengine.apps.firewall.ingressRules.patch",
+ "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}"
+ },
+ "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": {
+ "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": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate",
+ "path": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate",
+ "id": "appengine.apps.firewall.ingressRules.batchUpdate"
+ },
+ "delete": {
+ "description": "Deletes the specified firewall rule.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "appsId",
+ "ingressRulesId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ },
+ "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.delete"
+ },
+ "list": {
+ "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.",
+ "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": {
+ "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"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "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": "v1/apps/{appsId}/firewall/ingressRules"
+ }
+ }
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "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": {
+ "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"
+ },
+ "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"
+ ],
+ "flatPath": "v1/apps/{appsId}/locations",
+ "path": "v1/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list"
+ },
+ "get": {
+ "description": "Get information about a location.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "parameters": {
+ "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": "v1/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get",
+ "path": "v1/apps/{appsId}/locations/{locationsId}"
+ }
+ }
+ },
+ "authorizedCertificates": {
+ "methods": {
+ "list": {
+ "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": {
+ "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_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",
+ "description": "Lists all SSL certificates the user is authorized to administer."
+ },
+ "get": {
+ "description": "Gets the specified SSL certificate.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ],
+ "description": "Controls the set of fields returned in the GET response.",
+ "type": "string"
+ },
+ "authorizedCertificatesId": {
+ "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}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.get",
+ "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
+ },
+ "patch": {
+ "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.",
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "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"
+ },
+ "appsId": {
+ "location": "path",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
+ },
+ "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": "v1/apps/{appsId}/authorizedCertificates",
+ "path": "v1/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.create",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "description": "Uploads the specified SSL certificate."
+ },
+ "delete": {
+ "id": "appengine.apps.authorizedCertificates.delete",
+ "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "description": "Deletes the specified SSL certificate.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "authorizedCertificatesId": {
+ "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/authorizedCertificates/12345.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
+ }
+ }
}
}
}
},
"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"
- },
"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"
},
"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"
},
- "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"
+ },
+ "callback": {
"location": "query",
- "enum": [
- "1",
- "2"
- ]
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
"enum": [
@@ -1567,9 +1538,9 @@
"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"
},
"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.",
@@ -1581,1510 +1552,33 @@
"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"
}
},
"schemas": {
- "EndpointsApiService": {
- "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",
- "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"
- },
- "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.",
- "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": {
- "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"
- },
- "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": {
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "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."
- ]
- },
- "apiEndpoint": {
- "$ref": "ApiEndpointHandler",
- "description": "Uses API Endpoints to handle requests."
- },
- "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."
- ]
- }
- },
- "id": "UrlMap"
- },
- "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 a 401 HTTP status code and an error message."
- ]
- },
- "script": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- },
- "login": {
- "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."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ]
- },
- "url": {
- "description": "URL to serve the endpoint at.",
- "type": "string"
- }
- },
- "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": {
- "$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"
- }
- },
- "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"
- },
- "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": {
- "additionalProperties": {
- "type": "string"
- },
- "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"
- },
- "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": {
- "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",
- "type": "integer"
- },
- "targetWriteBytesPerSecond": {
- "description": "Target bytes written per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DiskUtilization"
- },
- "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"
- },
- "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": {
- "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",
- "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",
- "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"
- },
- "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",
- "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"
- }
- },
- "id": "LocationMetadata"
- },
- "Service": {
- "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"
- },
- "split": {
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
- "$ref": "TrafficSplit"
- }
- },
- "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"
- },
- "OperationMetadata": {
- "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"
- },
- "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"
- }
- },
- "id": "OperationMetadata",
- "description": "Metadata for the given google.longrunning.Operation.",
- "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"
- },
- "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"
- },
- "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": "FirewallRule"
- },
- "ListAuthorizedCertificatesResponse": {
- "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"
- }
- }
- },
- "id": "ListAuthorizedCertificatesResponse",
- "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
- "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"
- }
- },
- "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",
- "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"
- },
- "endTime": {
- "description": "Time that this operation completed.@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"
- },
- "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"
- },
- "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.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation. for Only applicable in the App Engine flexible environment.",
- "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 App Engine flexible environment application.",
- "type": "string"
- },
- "name": {
- "description": "Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.",
- "type": "string"
- }
- },
- "id": "Network"
- },
- "Application": {
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "type": "object",
- "properties": {
- "featureSettings": {
- "$ref": "FeatureSettings",
- "description": "The feature specific settings to be used in the application."
- },
- "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"
- },
- "codeBucket": {
- "description": "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"
- },
- "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"
- },
- "servingStatus": {
- "description": "Serving status of this application.",
- "type": "string",
- "enumDescriptions": [
- "Serving status is unspecified.",
- "Application is serving.",
- "Application has been disabled by the user.",
- "Application has been disabled by the system."
- ],
- "enum": [
- "UNSPECIFIED",
- "SERVING",
- "USER_DISABLED",
- "SYSTEM_DISABLED"
- ]
- },
- "defaultHostname": {
- "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
- "type": "string"
- }
- },
- "id": "Application"
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "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": "int32",
- "type": "integer"
- },
- "availability": {
- "description": "Availability of the instance.@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
- ],
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ]
- },
- "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",
- "type": "string"
- },
- "vmDebugEnabled": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
- },
- "requests": {
- "description": "Number of requests since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Instance"
- },
- "LivenessCheck": {
- "properties": {
- "initialDelay": {
- "description": "The initial delay before starting to execute the checks.",
- "format": "google-duration",
- "type": "string"
- },
- "path": {
- "description": "The request path.",
- "type": "string"
- },
- "successThreshold": {
- "description": "Number of consecutive successful checks required before considering the VM healthy.",
- "format": "uint32",
- "type": "integer"
- },
- "host": {
- "description": "Host header to send when performing a HTTP Liveness 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 considering the VM unhealthy.",
- "format": "uint32",
- "type": "integer"
- }
- },
- "id": "LivenessCheck",
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
- "type": "object"
- },
- "BatchUpdateIngressRulesRequest": {
- "description": "Request message for Firewall.BatchUpdateIngressRules.",
- "type": "object",
- "properties": {
- "ingressRules": {
- "description": "A list of FirewallRules to replace the existing set.",
- "type": "array",
- "items": {
- "$ref": "FirewallRule"
- }
- }
- },
- "id": "BatchUpdateIngressRulesRequest"
- },
- "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"
- },
- "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"
- }
- }
- },
- "id": "Location"
- },
- "NetworkUtilization": {
- "description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.",
- "type": "object",
- "properties": {
- "targetSentPacketsPerSecond": {
- "description": "Target packets sent per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReceivedBytesPerSecond": {
- "description": "Target bytes received per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReceivedPacketsPerSecond": {
- "description": "Target packets received per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetSentBytesPerSecond": {
- "description": "Target bytes sent 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",
- "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",
- "type": "integer"
- },
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
- "type": "boolean"
- },
- "host": {
- "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.",
- "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"
- }
- },
- "id": "HealthCheck"
- },
- "ReadinessCheck": {
- "properties": {
- "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",
- "type": "string"
- },
- "path": {
- "description": "The request path.",
- "type": "string"
- },
- "host": {
- "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"",
- "type": "string"
- },
- "successThreshold": {
- "description": "Number of consecutive successful checks required before receiving traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "ReadinessCheck",
- "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
- "type": "object"
- },
- "StandardSchedulerSettings": {
- "description": "Scheduler settings for standard environment.",
- "type": "object",
- "properties": {
- "minInstances": {
- "description": "Minimum number of instances for an app version. Set to a non-positive value (0 by convention) 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 a non-positive value (0 by convention) to disable max_instances configuration.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "StandardSchedulerSettings"
- },
- "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"
- },
- "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",
- "type": "string"
- },
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "endTime": {
- "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"
- },
- "Version": {
- "properties": {
- "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/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
- "format": "google-duration",
- "type": "string"
- },
- "libraries": {
- "description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.",
- "type": "array",
- "items": {
- "$ref": "Library"
- }
- },
- "nobuildFilesRegex": {
- "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
- "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"
- },
- "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"
- },
- "envVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object"
- },
- "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."
- },
- "network": {
- "description": "Extra network settings. Only applicable in the App Engine flexible environment.",
- "$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 for this version.Defaults to standard.",
- "type": "string"
- },
- "handlers": {
- "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
- "type": "array",
- "items": {
- "$ref": "UrlMap"
- }
- },
- "automaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "$ref": "AutomaticScaling"
- },
- "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": {
- "$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": {
- "$ref": "ApiConfigHandler",
- "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."
- },
- "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"
- },
- "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. 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."
- },
- "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": {
- "description": "Machine resources for this version. Only applicable for VM runtimes.",
- "$ref": "Resources"
- }
- },
- "id": "Version",
- "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
- "type": "object"
- },
- "RepairApplicationRequest": {
- "description": "Request message for 'Applications.RepairApplication'.",
- "type": "object",
- "properties": {},
- "id": "RepairApplicationRequest"
- },
- "CertificateRawData": {
- "properties": {
- "publicCertificate": {
- "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
- "type": "string"
- },
- "privateKey": {
- "description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
- "type": "string"
- }
- },
- "id": "CertificateRawData",
- "description": "An SSL certificate obtained from a certificate authority.",
- "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": {
- "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"
- },
- "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": {
- "properties": {
- "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",
- "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.",
- "type": "object",
- "properties": {
- "shardBy": {
- "enumDescriptions": [
- "Diversion method unspecified.",
- "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"
- ],
- "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": {
- "additionalProperties": {
- "format": "double",
- "type": "number"
- },
- "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service 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"
- },
- "OperationMetadataV1Beta": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- },
- "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": "OperationMetadataV1Beta"
- },
- "ListIngressRulesResponse": {
- "description": "Response message for Firewall.ListIngressRules.",
- "type": "object",
- "properties": {
- "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"
- },
- "ListServicesResponse": {
- "description": "Response message for Services.ListServices.",
- "type": "object",
- "properties": {
- "services": {
- "description": "The services belonging to the requested application.",
- "type": "array",
- "items": {
- "$ref": "Service"
- }
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- }
- },
- "id": "ListServicesResponse"
- },
- "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"
- },
- "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"
- }
- }
- },
- "id": "Deployment"
- },
- "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",
- "items": {
- "$ref": "Volume"
- }
- },
- "diskGb": {
- "description": "Disk size (GB) needed.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Resources"
- },
- "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"
- },
"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"
}
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
}
},
"id": "ListInstancesResponse"
@@ -3151,6 +1645,10 @@
"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"
@@ -3158,15 +1656,13 @@
"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": {
"versions": {
"description": "The versions belonging to the requested service.",
@@ -3180,9 +1676,7 @@
"type": "string"
}
},
- "id": "ListVersionsResponse",
- "description": "Response message for Versions.ListVersions.",
- "type": "object"
+ "id": "ListVersionsResponse"
},
"ListAuthorizedDomainsResponse": {
"description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
@@ -3209,15 +1703,15 @@
"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",
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object"
+ "id": "ApiEndpointHandler"
},
"DomainMapping": {
"description": "A domain serving an App Engine application.",
@@ -3245,27 +1739,24 @@
},
"id": "DomainMapping"
},
- "AutomaticScaling": {
+ "ZipInfo": {
+ "description": "The zip file information for a zip deployment.",
+ "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 in the App Engine flexible environment.",
- "format": "google-duration",
+ "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"
},
- "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.",
+ "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"
- },
- "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": "ZipInfo"
+ },
+ "AutomaticScaling": {
+ "properties": {
"diskUtilization": {
"$ref": "DiskUtilization",
"description": "Target scaling by disk usage."
@@ -3275,18 +1766,18 @@
"format": "google-duration",
"type": "string"
},
- "standardSchedulerSettings": {
- "$ref": "StandardSchedulerSettings",
- "description": "Scheduler settings for standard environment."
+ "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"
},
- "requestUtilization": {
- "$ref": "RequestUtilization",
- "description": "Target scaling by request utilization."
+ "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.",
@@ -3304,34 +1795,46 @@
"type": "integer"
},
"networkUtilization": {
- "$ref": "NetworkUtilization",
- "description": "Target scaling by network usage."
+ "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."
}
},
"id": "AutomaticScaling",
"description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
"type": "object"
},
- "ZipInfo": {
- "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",
- "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": {
+ "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",
@@ -3362,28 +1865,19 @@
"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": {
+ "description": "Resource record type. Example: AAAA.",
+ "type": "string",
"enumDescriptions": [
"An unknown resource record.",
"An A resource record. Data is an IPv4 address.",
@@ -3395,20 +1889,18 @@
"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"
+ "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\".",
@@ -3419,25 +1911,27 @@
"type": "string"
}
},
- "id": "Library"
+ "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": {
- "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",
- "description": "The response message for Locations.ListLocations.",
- "type": "object"
+ "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.",
@@ -3466,12 +1960,1518 @@
}
},
"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": {
+ "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"
+ },
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "UrlMap"
+ },
+ "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": {
+ "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": {
+ "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": {
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "httpHeaders": {
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object",
+ "additionalProperties": {
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "IdentityAwareProxy": {
+ "description": "Identity-Aware Proxy",
+ "type": "object",
+ "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"
+ },
+ "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"
+ },
+ "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",
+ "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"
+ }
+ },
+ "id": "LocationMetadata"
+ },
+ "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": {
+ "name": {
+ "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "split": {
+ "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"
+ }
+ },
+ "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"
+ },
+ "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"
+ },
+ "OperationMetadata": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "OperationMetadataV1": {
+ "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",
+ "items": {
+ "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"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
+ },
+ "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"
+ },
+ "Network": {
+ "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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "instanceTag": {
+ "description": "Tag to apply to the VM instance during creation. for Only applicable in the App Engine flexible environment.",
+ "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 App Engine flexible environment application.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Google Compute Engine 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 in the App Engine flexible environment.",
+ "type": "object"
+ },
+ "Application": {
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "enum": [
+ "UNSPECIFIED",
+ "SERVING",
+ "USER_DISABLED",
+ "SYSTEM_DISABLED"
+ ],
+ "description": "Serving status of this application.",
+ "type": "string",
+ "enumDescriptions": [
+ "Serving status is unspecified.",
+ "Application is serving.",
+ "Application has been disabled by the user.",
+ "Application has been disabled by the system."
+ ]
+ },
+ "defaultHostname": {
+ "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
+ },
+ "featureSettings": {
+ "$ref": "FeatureSettings",
+ "description": "The feature specific settings to be used in the application."
+ },
+ "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"
+ },
+ "codeBucket": {
+ "description": "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"
+ },
+ "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"
+ }
+ },
+ "id": "Application"
+ },
+ "Instance": {
+ "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"
+ },
+ "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"
+ },
+ "averageLatency": {
+ "description": "Average latency (ms) over the last minute.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ },
+ "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": "int32",
+ "type": "integer"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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": {
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
+ "type": "object",
+ "properties": {
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "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"
+ },
+ "path": {
+ "description": "The request path.",
+ "type": "string"
+ },
+ "host": {
+ "description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
+ "successThreshold": {
+ "description": "Number of consecutive successful checks required before considering the VM healthy.",
+ "format": "uint32",
+ "type": "integer"
+ }
+ },
+ "id": "LivenessCheck"
+ },
+ "BatchUpdateIngressRulesRequest": {
+ "properties": {
+ "ingressRules": {
+ "description": "A list of FirewallRules to replace the existing set.",
+ "type": "array",
+ "items": {
+ "$ref": "FirewallRule"
+ }
+ }
+ },
+ "id": "BatchUpdateIngressRulesRequest",
+ "description": "Request message for Firewall.BatchUpdateIngressRules.",
+ "type": "object"
+ },
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object",
+ "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 location.",
+ "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{\"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"
+ },
+ "NetworkUtilization": {
+ "properties": {
+ "targetSentBytesPerSecond": {
+ "description": "Target bytes sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetSentPacketsPerSecond": {
+ "description": "Target packets sent per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReceivedBytesPerSecond": {
+ "description": "Target bytes received per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReceivedPacketsPerSecond": {
+ "description": "Target packets received per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "NetworkUtilization",
+ "description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.",
+ "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": {
+ "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"
+ },
+ "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",
+ "type": "integer"
+ },
+ "disableHealthCheck": {
+ "description": "Whether to explicitly disable health checks for this instance.",
+ "type": "boolean"
+ }
+ },
+ "id": "HealthCheck"
+ },
+ "ReadinessCheck": {
+ "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",
+ "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",
+ "type": "string"
+ }
+ },
+ "id": "ReadinessCheck",
+ "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
+ "type": "object"
+ },
+ "StandardSchedulerSettings": {
+ "description": "Scheduler settings for standard environment.",
+ "type": "object",
+ "properties": {
+ "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 a non-positive value (0 by convention) to disable max_instances configuration.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minInstances": {
+ "description": "Minimum number of instances for an app version. Set to a non-positive value (0 by convention) to disable min_instances configuration.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "StandardSchedulerSettings"
+ },
+ "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"
+ },
+ "OperationMetadataV1Beta5": {
+ "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"
+ },
+ "method": {
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Beta5"
+ },
+ "Version": {
+ "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
+ "type": "object",
+ "properties": {
+ "automaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "$ref": "AutomaticScaling"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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. 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."
+ },
+ "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"
+ }
+ },
+ "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/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "libraries": {
+ "description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.",
+ "type": "array",
+ "items": {
+ "$ref": "Library"
+ }
+ },
+ "nobuildFilesRegex": {
+ "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
+ "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."
+ },
+ "runtime": {
+ "description": "Desired runtime. Example: python27.",
+ "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": {
+ "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.",
+ "$ref": "LivenessCheck"
+ },
+ "network": {
+ "description": "Extra network settings. Only applicable in the App Engine flexible environment.",
+ "$ref": "Network"
+ },
+ "betaSettings": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
+ "type": "object"
+ },
+ "env": {
+ "description": "App Engine execution environment for this version.Defaults to standard.",
+ "type": "string"
+ },
+ "handlers": {
+ "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
+ "type": "array",
+ "items": {
+ "$ref": "UrlMap"
+ }
+ }
+ },
+ "id": "Version"
+ },
+ "RepairApplicationRequest": {
+ "description": "Request message for 'Applications.RepairApplication'.",
+ "type": "object",
+ "properties": {},
+ "id": "RepairApplicationRequest"
+ },
+ "CertificateRawData": {
+ "description": "An SSL certificate obtained from a certificate authority.",
+ "type": "object",
+ "properties": {
+ "publicCertificate": {
+ "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
+ "type": "string"
+ },
+ "privateKey": {
+ "description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
+ "type": "string"
+ }
+ },
+ "id": "CertificateRawData"
+ },
+ "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"
+ },
+ "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": {
+ "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"
+ },
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
+ "type": "string"
+ }
+ },
+ "id": "FileInfo"
+ },
+ "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"
+ }
+ },
+ "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": {
+ "enumDescriptions": [
+ "Diversion method unspecified.",
+ "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"
+ ],
+ "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": {
+ "additionalProperties": {
+ "format": "double",
+ "type": "number"
+ },
+ "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service 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"
+ },
+ "OperationMetadataV1Beta": {
+ "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.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadataV1Beta"
+ },
+ "ListServicesResponse": {
+ "description": "Response message for Services.ListServices.",
+ "type": "object",
+ "properties": {
+ "services": {
+ "description": "The services belonging to the requested application.",
+ "type": "array",
+ "items": {
+ "$ref": "Service"
+ }
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListServicesResponse"
+ },
+ "ListIngressRulesResponse": {
+ "description": "Response message for Firewall.ListIngressRules.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "Deployment",
+ "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "type": "object"
+ },
+ "Resources": {
+ "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",
+ "description": "Machine resources for a version.",
+ "type": "object"
+ },
+ "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"
}
},
- "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"
+ "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://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",
+ "servicePath": "",
+ "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications."
}
diff --git a/appengine/v1alpha/appengine-api.json b/appengine/v1alpha/appengine-api.json
index cd38226..e2a15d8 100644
--- a/appengine/v1alpha/appengine-api.json
+++ b/appengine/v1alpha/appengine-api.json
@@ -1,288 +1,70 @@
{
- "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/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",
- "batchPath": "batch",
- "revision": "20171213",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "id": "appengine:v1alpha",
- "title": "Google App Engine Admin API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
"resources": {
"apps": {
"resources": {
- "authorizedCertificates": {
+ "authorizedDomains": {
"methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- }
- },
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.delete",
- "description": "Deletes the specified SSL certificate."
- },
"list": {
"response": {
- "$ref": "ListAuthorizedCertificatesResponse"
+ "$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": {
+ "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"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC_CERTIFICATE",
- "FULL_CERTIFICATE"
- ],
- "description": "Controls the set of fields returned in the LIST response.",
- "type": "string"
- },
- "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"
}
},
- "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}/authorizedCertificates",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates",
- "id": "appengine.apps.authorizedCertificates.list",
- "description": "Lists all SSL certificates the user is authorized to administer."
- },
- "get": {
- "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"
- ],
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.get",
- "description": "Gets the specified SSL certificate."
- },
- "patch": {
- "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.patch",
- "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "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.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId",
- "authorizedCertificatesId"
- ],
- "response": {
- "$ref": "AuthorizedCertificate"
- },
- "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"
- ]
- },
- "create": {
- "request": {
- "$ref": "AuthorizedCertificate"
- },
- "description": "Uploads the specified SSL certificate.",
- "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"
- }
- }
- },
- "authorizedDomains": {
- "methods": {
- "list": {
- "description": "Lists all domains the user is authorized to administer.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListAuthorizedDomainsResponse"
- },
- "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": {
- "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": "v1alpha/apps/{appsId}/authorizedDomains",
+ "path": "v1alpha/apps/{appsId}/authorizedDomains",
"id": "appengine.apps.authorizedDomains.list",
- "path": "v1alpha/apps/{appsId}/authorizedDomains"
+ "description": "Lists all domains the user is authorized to administer."
}
}
},
"operations": {
"methods": {
"list": {
+ "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": {
- "filter": {
- "description": "The standard list filter.",
- "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"
+ },
"appsId": {
"location": "path",
"description": "Part of `name`. The name of the operation's parent resource.",
@@ -293,21 +75,19 @@
"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"
+ ],
"flatPath": "v1alpha/apps/{appsId}/operations",
- "path": "v1alpha/apps/{appsId}/operations",
"id": "appengine.apps.operations.list",
+ "path": "v1alpha/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": {
- "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"
},
@@ -324,10 +104,10 @@
"type": "string"
},
"operationsId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -337,32 +117,26 @@
],
"flatPath": "v1alpha/apps/{appsId}/operations/{operationsId}",
"path": "v1alpha/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get"
+ "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."
}
}
},
"locations": {
"methods": {
"list": {
- "description": "Lists information about the supported locations for this service.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"appsId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
"parameters": {
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
"filter": {
- "description": "The standard list filter.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "The standard list filter."
},
"appsId": {
"location": "path",
@@ -371,9 +145,15 @@
"type": "string"
},
"pageToken": {
+ "location": "query",
"description": "The standard list page token.",
- "type": "string",
- "location": "query"
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32"
}
},
"scopes": [
@@ -382,29 +162,21 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1alpha/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list",
"path": "v1alpha/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list"
+ "description": "Lists information about the supported locations for this service."
},
"get": {
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "httpMethod": "GET",
"parameters": {
- "locationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `name`. Resource name for the location.",
"required": true,
"type": "string",
"location": "path"
},
- "appsId": {
+ "locationsId": {
"location": "path",
- "description": "Part of `name`. Resource name for the location.",
+ "description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
}
@@ -416,15 +188,22 @@
],
"flatPath": "v1alpha/apps/{appsId}/locations/{locationsId}",
"path": "v1alpha/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get"
+ "id": "appengine.apps.locations.get",
+ "description": "Get information about a location.",
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "httpMethod": "GET"
}
}
},
"domainMappings": {
"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.",
- "httpMethod": "DELETE",
"response": {
"$ref": "Operation"
},
@@ -432,28 +211,31 @@
"appsId",
"domainMappingsId"
],
+ "httpMethod": "DELETE",
"parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to delete. 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"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
"id": "appengine.apps.domainMappings.delete",
- "path": "v1alpha/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": {
+ "description": "Lists the domain mappings on an application.",
"response": {
"$ref": "ListDomainMappingsResponse"
},
@@ -461,11 +243,6 @@
"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",
@@ -479,16 +256,20 @@
"location": "query"
},
"pageSize": {
+ "location": "query",
"description": "Maximum results to return per page.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "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": "v1alpha/apps/{appsId}/domainMappings",
"path": "v1alpha/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.list",
- "description": "Lists the domain mappings on an application."
+ "id": "appengine.apps.domainMappings.list"
},
"get": {
"response": {
@@ -499,14 +280,224 @@
"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": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`."
+ },
"appsId": {
"location": "path",
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
"required": true,
"type": "string"
+ }
+ },
+ "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.get",
+ "description": "Gets the specified domain mapping."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId",
+ "domainMappingsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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": {
+ "type": "boolean",
+ "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."
+ },
+ "updateMask": {
+ "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": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.patch",
+ "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "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": {
+ "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",
+ "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"
+ },
+ "noManagedCertificate": {
+ "description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manaually 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.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "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}/domainMappings",
+ "id": "appengine.apps.domainMappings.create",
+ "path": "v1alpha/apps/{appsId}/domainMappings"
+ }
+ }
+ },
+ "authorizedCertificates": {
+ "methods": {
+ "delete": {
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.delete",
+ "description": "Deletes the specified SSL certificate.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "authorizedCertificatesId": {
+ "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 delete. Example: apps/myapp/authorizedCertificates/12345.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
+ },
+ "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": {
+ "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": {
+ "description": "Controls the set of fields returned in the LIST response.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ]
+ }
+ },
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.list"
+ },
+ "get": {
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "parameterOrder": [
+ "appsId",
+ "authorizedCertificatesId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "view": {
+ "enum": [
+ "BASIC_CERTIFICATE",
+ "FULL_CERTIFICATE"
+ ],
+ "description": "Controls the set of fields returned in the GET response.",
+ "type": "string",
+ "location": "query"
+ },
+ "authorizedCertificatesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
@@ -518,87 +509,60 @@
"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",
- "description": "Gets the specified domain mapping."
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.get",
+ "description": "Gets the specified SSL certificate."
},
"patch": {
- "request": {
- "$ref": "DomainMapping"
+ "response": {
+ "$ref": "AuthorizedCertificate"
},
- "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"
+ "authorizedCertificatesId"
],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "domainMappingsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "noManagedCertificate": {
- "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",
- "location": "query"
- },
- "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 resource to update. Example: apps/myapp/domainMappings/example.com.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
+ "httpMethod": "PATCH",
"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}"
+ "parameters": {
+ "authorizedCertificatesId": {
+ "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. Updates are only supported on the certificate_raw_data and display_name fields.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "appsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345."
+ }
+ },
+ "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.",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ }
},
"create": {
- "flatPath": "v1alpha/apps/{appsId}/domainMappings",
- "path": "v1alpha/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.",
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"appsId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "AuthorizedCertificate"
+ },
"parameters": {
- "overrideStrategy": {
- "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.",
- "type": "string",
- "location": "query",
- "enum": [
- "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY",
- "STRICT",
- "OVERRIDE"
- ]
- },
- "noManagedCertificate": {
- "location": "query",
- "description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manaually 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.",
- "type": "boolean"
- },
"appsId": {
"location": "path",
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
@@ -608,7 +572,14 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "id": "appengine.apps.authorizedCertificates.create",
+ "path": "v1alpha/apps/{appsId}/authorizedCertificates",
+ "request": {
+ "$ref": "AuthorizedCertificate"
+ },
+ "description": "Uploads the specified SSL certificate."
}
}
}
@@ -627,33 +598,33 @@
"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": {
+ "uploadType": {
"location": "query",
- "description": "JSONP",
+ "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"
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
},
"alt": {
"enum": [
@@ -671,411 +642,58 @@
"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"
},
- "access_token": {
- "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"
},
- "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"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
}
},
"schemas": {
- "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"
- },
- "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": {
- "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."
- ],
- "enum": [
- "UNSPECIFIED_STATUS",
- "OK",
- "PENDING",
- "FAILED_RETRYING_INTERNAL",
- "FAILED_RETRYING_NOT_VISIBLE",
- "FAILED_PERMANENTLY_NOT_VISIBLE",
- "FAILED_RETRYING_CAA_FORBIDDEN",
- "FAILED_RETRYING_CAA_CHECKING"
- ]
- }
- },
- "id": "ManagedCertificate"
- },
- "CertificateRawData": {
- "description": "An SSL certificate obtained from a certificate authority.",
- "type": "object",
- "properties": {
- "publicCertificate": {
- "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
- "type": "string"
- },
- "privateKey": {
- "description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
- "type": "string"
- }
- },
- "id": "CertificateRawData"
- },
- "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.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"
- },
- "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"
- }
- },
- "id": "SslSettings"
- },
- "OperationMetadataV1": {
- "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",
- "description": "Metadata for the given google.longrunning.Operation.",
- "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": {
- "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": {
- "$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"
- }
- },
- "id": "Operation"
- },
- "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": {
- "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"
- },
- "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": "OperationMetadataV1Alpha"
- },
- "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": {
- "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 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"
- },
- "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"
- },
- "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": {
- "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"
- },
- "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"
- },
- "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"
- }
- },
- "id": "LocationMetadata"
- },
- "OperationMetadataV1Beta": {
- "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.v1beta.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "OperationMetadataV1Beta"
- },
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"type": "object",
"properties": {
- "locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
+ "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": {
+ "type": "string",
+ "description": "The canonical id for this location. For example: \"us-east1\"."
+ },
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -1083,23 +701,26 @@
},
"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"
- }
- },
- "name": {
- "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
- "type": "string"
}
},
"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.",
+ "type": "string"
+ },
+ "certificateRawData": {
+ "$ref": "CertificateRawData",
+ "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"
+ },
"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",
@@ -1129,30 +750,18 @@
}
},
"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"
- },
- "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"
- },
- "certificateRawData": {
- "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.",
- "$ref": "CertificateRawData"
+ "type": "string",
+ "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly"
}
},
- "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"
+ "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.",
@@ -1170,35 +779,31 @@
"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"
}
},
- "id": "ResourceRecord"
+ "id": "ResourceRecord",
+ "description": "A DNS resource record.",
+ "type": "object"
},
"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"
- }
+ },
+ "description": "A list of operations that matches the specified filter in the request."
},
"nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
+ "type": "string",
+ "description": "The standard List next-page token."
}
},
- "id": "ListOperationsResponse"
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations."
},
"OperationMetadata": {
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object",
"properties": {
"method": {
"description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
@@ -1218,16 +823,18 @@
"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"
+ "type": "string",
+ "description": "User who requested this operation.@OutputOnly"
+ },
+ "target": {
+ "type": "string",
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly"
}
},
- "id": "OperationMetadata"
+ "id": "OperationMetadata",
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
},
"ListAuthorizedCertificatesResponse": {
"description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
@@ -1238,11 +845,11 @@
"type": "string"
},
"certificates": {
- "description": "The SSL certificates the user is authorized to administer.",
"type": "array",
"items": {
"$ref": "AuthorizedCertificate"
- }
+ },
+ "description": "The SSL certificates the user is authorized to administer."
}
},
"id": "ListAuthorizedCertificatesResponse"
@@ -1251,17 +858,9 @@
"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"
- },
"method": {
- "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly"
},
"insertTime": {
"description": "Timestamp that this operation was created.@OutputOnly",
@@ -1272,16 +871,417 @@
"description": "Timestamp that this operation completed.@OutputOnly",
"format": "google-datetime",
"type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
+ },
+ "target": {
+ "type": "string",
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly"
}
},
"id": "OperationMetadataV1Beta5"
+ },
+ "ListLocationsResponse": {
+ "id": "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"
+ }
+ }
+ },
+ "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"
+ },
+ "CertificateRawData": {
+ "id": "CertificateRawData",
+ "description": "An SSL certificate obtained from a certificate authority.",
+ "type": "object",
+ "properties": {
+ "publicCertificate": {
+ "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
+ "type": "string"
+ },
+ "privateKey": {
+ "description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN RSA PRIVATE KEY----- \u003cunencrypted_key_value\u003e -----END RSA PRIVATE KEY----- \u003c/pre\u003e @InputOnly",
+ "type": "string"
+ }
+ }
+ },
+ "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"
+ },
+ "OperationMetadataV1": {
+ "id": "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": {
+ "type": "string",
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime"
+ },
+ "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": {
+ "type": "string",
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ }
+ }
+ },
+ "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": {
+ "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."
+ }
+ },
+ "id": "Operation"
+ },
+ "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": {
+ "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.v1alpha.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "type": "string",
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime"
+ },
+ "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": "OperationMetadataV1Alpha",
+ "description": "Metadata for the given google.longrunning.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.",
+ "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": {
+ "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"
+ },
+ "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"
+ },
+ "AuthorizedDomain": {
+ "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"
+ }
+ },
+ "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)."
+ },
+ "DomainMapping": {
+ "id": "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": {
+ "$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"
+ },
+ "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"
+ }
+ }
+ }
+ },
+ "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"
+ }
+ },
+ "id": "LocationMetadata"
+ },
+ "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"
+ },
+ "OperationMetadataV1Beta": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "method": {
+ "type": "string",
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly"
+ },
+ "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"
+ }
+ },
+ "id": "OperationMetadataV1Beta"
}
},
- "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": "v1alpha",
- "baseUrl": "https://appengine.googleapis.com/"
+ "baseUrl": "https://appengine.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/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",
+ "batchPath": "batch",
+ "revision": "20171213",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "id": "appengine:v1alpha",
+ "title": "Google App Engine Admin API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google"
}
diff --git a/appengine/v1beta/appengine-api.json b/appengine/v1beta/appengine-api.json
index 46c47a6..3df33c7 100644
--- a/appengine/v1beta/appengine-api.json
+++ b/appengine/v1beta/appengine-api.json
@@ -1,48 +1,31 @@
{
+ "batchPath": "batch",
+ "id": "appengine:v1beta",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "revision": "20171213",
+ "title": "Google App Engine Admin API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"apps": {
"methods": {
- "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.",
- "response": {
- "$ref": "Operation"
- },
+ "get": {
+ "id": "appengine.apps.get",
+ "path": "v1beta/apps/{appsId}",
+ "description": "Gets information about an application.",
+ "httpMethod": "GET",
"parameterOrder": [
"appsId"
],
- "httpMethod": "POST",
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}:repair",
- "path": "v1beta/apps/{appsId}:repair",
- "id": "appengine.apps.repair"
- },
- "get": {
"response": {
"$ref": "Application"
},
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
"parameters": {
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -50,13 +33,9 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1beta/apps/{appsId}",
- "path": "v1beta/apps/{appsId}",
- "id": "appengine.apps.get",
- "description": "Gets information about an application."
+ "flatPath": "v1beta/apps/{appsId}"
},
"patch": {
- "flatPath": "v1beta/apps/{appsId}",
"path": "v1beta/apps/{appsId}",
"id": "appengine.apps.patch",
"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.",
@@ -74,19 +53,20 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
"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 Application resource to update. Example: apps/myapp.",
+ "required": true,
"type": "string",
- "location": "query"
+ "location": "path"
}
- }
+ },
+ "flatPath": "v1beta/apps/{appsId}"
},
"create": {
"response": {
@@ -105,6 +85,33 @@
"$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/)."
+ },
+ "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.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
+ "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",
+ "path": "v1beta/apps/{appsId}:repair",
+ "id": "appengine.apps.repair"
}
},
"resources": {
@@ -112,29 +119,19 @@
"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": {
- "location": "path",
"description": "Part of `name`. The resource that owns the locations collection, if applicable.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"pageToken": {
"location": "query",
@@ -146,14 +143,23 @@
"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/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"flatPath": "v1beta/apps/{appsId}/locations",
- "path": "v1beta/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list"
+ "id": "appengine.apps.locations.list",
+ "path": "v1beta/apps/{appsId}/locations"
},
"get": {
- "description": "Get information about a location.",
"response": {
"$ref": "Location"
},
@@ -168,22 +174,23 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
- "appsId": {
- "description": "Part of `name`. Resource name for the location.",
+ "locationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
"location": "path"
},
- "locationsId": {
+ "appsId": {
"location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
+ "description": "Part of `name`. Resource name for the location.",
"required": true,
"type": "string"
}
},
"flatPath": "v1beta/apps/{appsId}/locations/{locationsId}",
"path": "v1beta/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get"
+ "id": "appengine.apps.locations.get",
+ "description": "Get information about a location."
}
}
},
@@ -206,10 +213,10 @@
],
"parameters": {
"appsId": {
+ "location": "path",
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"flatPath": "v1beta/apps/{appsId}/authorizedCertificates",
@@ -217,7 +224,6 @@
"id": "appengine.apps.authorizedCertificates.create"
},
"delete": {
- "description": "Deletes the specified SSL certificate.",
"response": {
"$ref": "Empty"
},
@@ -226,26 +232,27 @@
"authorizedCertificatesId"
],
"httpMethod": "DELETE",
- "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"
],
+ "parameters": {
+ "authorizedCertificatesId": {
+ "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 delete. Example: apps/myapp/authorizedCertificates/12345.",
+ "required": true,
+ "type": "string"
+ }
+ },
"flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
"path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.delete"
+ "id": "appengine.apps.authorizedCertificates.delete",
+ "description": "Deletes the specified SSL certificate."
},
"list": {
"description": "Lists all SSL certificates the user is authorized to administer.",
@@ -269,9 +276,9 @@
"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.",
@@ -295,7 +302,6 @@
},
"get": {
"description": "Gets the specified SSL certificate.",
- "httpMethod": "GET",
"response": {
"$ref": "AuthorizedCertificate"
},
@@ -303,13 +309,13 @@
"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": {
- "authorizedCertificatesId": {
- "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/authorizedCertificates/12345.",
"required": true,
@@ -317,25 +323,32 @@
"location": "path"
},
"view": {
- "description": "Controls the set of fields returned in the GET response.",
- "type": "string",
- "location": "query",
"enum": [
"BASIC_CERTIFICATE",
"FULL_CERTIFICATE"
- ]
+ ],
+ "description": "Controls the set of fields returned in the GET response.",
+ "type": "string",
+ "location": "query"
+ },
+ "authorizedCertificatesId": {
+ "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}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.get",
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}"
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "id": "appengine.apps.authorizedCertificates.get"
},
"patch": {
+ "id": "appengine.apps.authorizedCertificates.patch",
+ "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
+ "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.",
"httpMethod": "PATCH",
"parameterOrder": [
"appsId",
@@ -346,10 +359,10 @@
},
"parameters": {
"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"
+ "type": "string",
+ "location": "query"
},
"appsId": {
"location": "path",
@@ -358,8 +371,41 @@
"type": "string"
},
"authorizedCertificatesId": {
+ "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}/authorizedCertificates/{authorizedCertificatesId}"
+ }
+ }
+ },
+ "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"
}
@@ -367,96 +413,130 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "id": "appengine.apps.authorizedCertificates.patch",
- "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
- "request": {
- "$ref": "AuthorizedCertificate"
+ "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"
},
- "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."
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "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"
+ }
+ },
+ "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": {
+ "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.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.get"
+ },
+ "patch": {
+ "description": "Updates the configuration of the specified service.",
+ "request": {
+ "$ref": "Service"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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.",
+ "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/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"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.patch"
}
- }
- },
- "services": {
+ },
"resources": {
"versions": {
"methods": {
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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 resource to create this version under. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create",
- "description": "Deploys code and resource files to a new version.",
- "request": {
- "$ref": "Version"
- }
- },
- "delete": {
- "description": "Deletes an existing Version resource.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "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/versions/v1.",
- "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}",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.delete"
- },
"list": {
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.list",
- "description": "Lists the versions of a service.",
"response": {
"$ref": "ListVersionsResponse"
},
@@ -478,53 +558,47 @@
"type": "integer"
},
"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"
},
"servicesId": {
- "location": "path",
"description": "Part of `parent`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "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"
+ "type": "string",
+ "location": "path"
},
"pageToken": {
+ "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string",
- "location": "query"
+ "type": "string"
}
},
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions"
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.list",
+ "description": "Lists the versions of a service."
},
"get": {
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.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"
- },
+ "httpMethod": "GET",
"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"
- ],
+ "response": {
+ "$ref": "Version"
+ },
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
@@ -533,10 +607,10 @@
"location": "path"
},
"versionsId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"view": {
"location": "query",
@@ -553,16 +627,18 @@
"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}/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."
},
"patch": {
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "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.",
"response": {
"$ref": "Operation"
},
@@ -573,18 +649,87 @@
],
"httpMethod": "PATCH",
"parameters": {
- "versionsId": {
- "location": "path",
+ "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"
+ },
+ "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": {
+ "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}/versions/{versionsId}",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "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": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "required": true,
"type": "string"
},
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
+ "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"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.create",
+ "description": "Deploys code and resource files to a new version.",
+ "request": {
+ "$ref": "Version"
+ }
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
"servicesId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
@@ -593,14 +738,24 @@
},
"appsId": {
"location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "required": true,
+ "type": "string"
+ },
+ "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}",
+ "id": "appengine.apps.services.versions.delete",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "description": "Deletes an existing Version resource."
}
},
"resources": {
@@ -616,24 +771,17 @@
"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": {
- "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"
- },
"servicesId": {
- "location": "path",
"description": "Part of `parent`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"appsId": {
"description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
@@ -645,22 +793,26 @@
"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": {
+ "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": "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": {
- "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",
"description": "Gets instance information.",
"response": {
"$ref": "Instance"
@@ -672,18 +824,17 @@
"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"
+ ],
"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": {
"description": "Part of `name`. See documentation of `appsId`.",
@@ -696,13 +847,17 @@
"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": "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": {
"response": {
@@ -715,19 +870,10 @@
"instancesId"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"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`.",
@@ -735,26 +881,33 @@
"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/instances/instance-1.",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
"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}: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"
- },
- "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."
+ }
},
"delete": {
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.delete",
"description": "Stops a running instance.",
"response": {
"$ref": "Operation"
@@ -766,6 +919,9 @@
"instancesId"
],
"httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"servicesId": {
"location": "path",
@@ -774,17 +930,17 @@
"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"
},
+ "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,
@@ -792,168 +948,22 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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.delete"
}
}
}
}
}
- },
- "methods": {
- "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": {
- "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"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services",
- "path": "v1beta/apps/{appsId}/services",
- "id": "appengine.apps.services.list"
- },
- "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": {
- "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"
- }
- },
- "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": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "servicesId": {
- "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}",
- "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",
- "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": "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": {
+ "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.",
"response": {
"$ref": "ListAuthorizedDomainsResponse"
@@ -962,33 +972,30 @@
"appsId"
],
"httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "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"
- }
- },
"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",
- "path": "v1beta/apps/{appsId}/authorizedDomains",
- "id": "appengine.apps.authorizedDomains.list"
+ "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"
+ }
+ }
}
}
},
@@ -1037,7 +1044,6 @@
]
},
"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"
},
@@ -1053,30 +1059,138 @@
],
"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",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"flatPath": "v1beta/apps/{appsId}/operations/{operationsId}",
"path": "v1beta/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get"
+ "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."
}
}
},
"domainMappings": {
"methods": {
- "create": {
+ "list": {
+ "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": {
+ "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": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
"flatPath": "v1beta/apps/{appsId}/domainMappings",
"path": "v1beta/apps/{appsId}/domainMappings",
- "id": "appengine.apps.domainMappings.create",
+ "id": "appengine.apps.domainMappings.list",
+ "description": "Lists the domain mappings on an application."
+ },
+ "get": {
+ "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
+ "id": "appengine.apps.domainMappings.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"
+ ]
+ },
+ "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": {
+ "description": "Part of `name`. Name of the resource to update. 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.patch"
+ },
+ "create": {
"request": {
"$ref": "DomainMapping"
},
@@ -1089,12 +1203,6 @@
],
"httpMethod": "POST",
"parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
- "required": true,
- "type": "string"
- },
"overrideStrategy": {
"location": "query",
"enum": [
@@ -1104,11 +1212,20 @@
],
"description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.",
"type": "string"
+ },
+ "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": "v1beta/apps/{appsId}/domainMappings",
+ "path": "v1beta/apps/{appsId}/domainMappings",
+ "id": "appengine.apps.domainMappings.create"
},
"delete": {
"response": {
@@ -1140,116 +1257,6 @@
"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."
- },
- "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": {
- "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"
- }
- },
- "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": {
- "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"
- }
- },
- "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": {
- "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": {
- "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"
- },
- "domainMappingsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}",
- "id": "appengine.apps.domainMappings.patch"
}
}
},
@@ -1257,8 +1264,109 @@
"resources": {
"ingressRules": {
"methods": {
+ "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": {
+ "description": "Lists the firewall rules of an application.",
+ "response": {
+ "$ref": "ListIngressRulesResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "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}/firewall/ingressRules",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "id": "appengine.apps.firewall.ingressRules.list"
+ },
+ "create": {
+ "description": "Creates a firewall rule for the application.",
+ "request": {
+ "$ref": "FirewallRule"
+ },
+ "response": {
+ "$ref": "FirewallRule"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules",
+ "id": "appengine.apps.firewall.ingressRules.create"
+ },
"get": {
"description": "Gets the specified firewall rule.",
+ "httpMethod": "GET",
"response": {
"$ref": "FirewallRule"
},
@@ -1266,19 +1374,18 @@
"appsId",
"ingressRulesId"
],
- "httpMethod": "GET",
"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"
- },
- "appsId": {
- "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.",
- "required": true,
- "type": "string",
- "location": "path"
}
},
"scopes": [
@@ -1287,25 +1394,24 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "id": "appengine.apps.firewall.ingressRules.get"
+ "id": "appengine.apps.firewall.ingressRules.get",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}"
},
"patch": {
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
"id": "appengine.apps.firewall.ingressRules.patch",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}",
"request": {
"$ref": "FirewallRule"
},
"description": "Updates the specified firewall rule.",
- "response": {
- "$ref": "FirewallRule"
- },
+ "httpMethod": "PATCH",
"parameterOrder": [
"appsId",
"ingressRulesId"
],
- "httpMethod": "PATCH",
+ "response": {
+ "$ref": "FirewallRule"
+ },
"parameters": {
"appsId": {
"description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.",
@@ -1320,21 +1426,18 @@
"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"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}"
},
"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.",
"httpMethod": "POST",
"parameterOrder": [
"appsId"
@@ -1355,107 +1458,11 @@
],
"flatPath": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
"id": "appengine.apps.firewall.ingressRules.batchUpdate",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate"
- },
- "delete": {
- "description": "Deletes the specified firewall rule.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "appsId",
- "ingressRulesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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": {
- "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.delete"
- },
- "list": {
- "description": "Lists the firewall rules of an application.",
- "response": {
- "$ref": "ListIngressRulesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "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"
- }
- },
- "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}/firewall/ingressRules",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules",
- "id": "appengine.apps.firewall.ingressRules.list"
- },
- "create": {
- "response": {
- "$ref": "FirewallRule"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules",
- "path": "v1beta/apps/{appsId}/firewall/ingressRules",
- "id": "appengine.apps.firewall.ingressRules.create",
- "description": "Creates a firewall rule for the application.",
+ "path": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate",
"request": {
- "$ref": "FirewallRule"
- }
+ "$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."
}
}
}
@@ -1465,7 +1472,30 @@
}
},
"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": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1474,9 +1504,7 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
+ ]
},
"callback": {
"description": "JSONP",
@@ -1499,16 +1527,16 @@
"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"
},
+ "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.",
@@ -1526,44 +1554,103 @@
"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": {
- "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
}
},
"schemas": {
+ "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": {
+ "$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"
+ },
+ "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": {
+ "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."
+ ],
+ "enum": [
+ "A",
+ "AAAA",
+ "CNAME"
+ ]
+ },
+ "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": {
- "version": {
- "description": "Version of the library to select, or \"latest\".",
- "type": "string"
- },
"name": {
"description": "Name of the library. Example: \"django\".",
"type": "string"
+ },
+ "version": {
+ "description": "Version of the library to select, or \"latest\".",
+ "type": "string"
}
},
"id": "Library"
@@ -1572,42 +1659,42 @@
"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"
},
"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 in the App Engine flexible environment.",
"type": "object",
"properties": {
- "targetConcurrentRequests": {
- "description": "Target number of concurrent requests.",
+ "targetRequestCountPerSecond": {
+ "description": "Target requests per second.",
"format": "int32",
"type": "integer"
},
- "targetRequestCountPerSecond": {
- "description": "Target requests per second.",
+ "targetConcurrentRequests": {
+ "description": "Target number of concurrent requests.",
"format": "int32",
"type": "integer"
}
@@ -1630,7 +1717,35 @@
"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": {
+ "apiEndpoint": {
+ "$ref": "ApiEndpointHandler",
+ "description": "Uses API Endpoints to handle requests."
+ },
+ "staticFiles": {
+ "$ref": "StaticFilesHandler",
+ "description": "Returns the contents of a file, such as an image, as the response."
+ },
+ "redirectHttpResponseCode": {
+ "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."
+ ],
+ "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": {
"enumDescriptions": [
"Not specified.",
@@ -1650,8 +1765,6 @@
"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.",
@@ -1661,11 +1774,13 @@
"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"
},
"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.",
@@ -1686,74 +1801,15 @@
],
"description": "Level of login required to access this resource.",
"type": "string"
- },
- "apiEndpoint": {
- "$ref": "ApiEndpointHandler",
- "description": "Uses API Endpoints to handle requests."
- },
- "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",
- "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"
},
"ApiConfigHandler": {
"description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
"type": "object",
"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",
@@ -1762,29 +1818,70 @@
"SECURE_ALWAYS"
],
"description": "Security (HTTPS) enforcement for this URL.",
- "type": "string"
+ "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 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": {
+ "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"
}
},
"id": "ApiConfigHandler"
},
"Operation": {
- "description": "This resource represents a long-running operation that is the result of a network 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": "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"
@@ -1800,26 +1897,24 @@
"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"
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "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": {
+ "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",
@@ -1830,11 +1925,11 @@
"type": "boolean"
},
"httpHeaders": {
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "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.",
@@ -1843,14 +1938,6 @@
"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"
@@ -1859,6 +1946,11 @@
"description": "Target scaling by disk usage. Only applicable in the App Engine flexible environment.",
"type": "object",
"properties": {
+ "targetWriteOpsPerSecond": {
+ "description": "Target ops written per second.",
+ "format": "int32",
+ "type": "integer"
+ },
"targetWriteBytesPerSecond": {
"description": "Target bytes written per second.",
"format": "int32",
@@ -1873,11 +1965,6 @@
"description": "Target ops read per seconds.",
"format": "int32",
"type": "integer"
- },
- "targetWriteOpsPerSecond": {
- "description": "Target ops written per second.",
- "format": "int32",
- "type": "integer"
}
},
"id": "DiskUtilization"
@@ -1916,37 +2003,10 @@
},
"id": "CpuUtilization"
},
- "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"
- },
"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",
@@ -1962,10 +2022,37 @@
"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": {
+ "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"
+ },
"ManualScaling": {
"properties": {
"instances": {
@@ -1979,6 +2066,8 @@
"type": "object"
},
"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",
@@ -1989,64 +2078,47 @@
"type": "boolean"
}
},
- "id": "LocationMetadata",
- "description": "Metadata for the given google.cloud.location.Location.",
- "type": "object"
+ "id": "LocationMetadata"
},
"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": {
+ "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",
- "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"
+ "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"
}
+ },
+ "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"
- },
- "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"
@@ -2059,9 +2131,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"
},
"FirewallRule": {
"description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.",
@@ -2101,16 +2188,16 @@
"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"
@@ -2130,67 +2217,9 @@
},
"id": "FeatureSettings"
},
- "ErrorHandler": {
- "description": "Custom static error page to be served when an error occurs.",
- "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.",
- "type": "string"
- },
- "staticFile": {
- "description": "Static file content to be served for this error.",
- "type": "string"
- }
- },
- "id": "ErrorHandler"
- },
- "SslSettings": {
- "description": "SSL configuration for a DomainMapping resource.",
- "type": "object",
- "properties": {
- "pendingManagedCertificateId": {
- "description": "ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly",
- "type": "string"
- },
- "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 SslManagementType.MANUAL 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"
- },
- "sslManagementType": {
- "enumDescriptions": [
- "SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.",
- "SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain."
- ],
- "enum": [
- "AUTOMATIC",
- "MANUAL"
- ],
- "description": "SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.",
- "type": "string"
- }
- },
- "id": "SslSettings"
- },
"OperationMetadataV1": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
"properties": {
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
@@ -2226,8 +2255,92 @@
"type": "string"
}
},
- "id": "OperationMetadataV1",
- "description": "Metadata for the given google.longrunning.Operation.",
+ "id": "OperationMetadataV1"
+ },
+ "SslSettings": {
+ "description": "SSL configuration for a DomainMapping resource.",
+ "type": "object",
+ "properties": {
+ "pendingManagedCertificateId": {
+ "description": "ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificate_id field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificate_id field with an UpdateDomainMappingRequest.@OutputOnly",
+ "type": "string"
+ },
+ "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 SslManagementType.MANUAL 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"
+ },
+ "sslManagementType": {
+ "description": "SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificate_id must be manually specified in order to configure SSL for this domain.",
+ "type": "string",
+ "enumDescriptions": [
+ "SSL support for this domain is configured automatically. The mapped SSL certificate will be automatically renewed.",
+ "SSL support for this domain is configured manually by the user. Either the domain has no SSL support or a user-obtained SSL certificate has been explictly mapped to this domain."
+ ],
+ "enum": [
+ "AUTOMATIC",
+ "MANUAL"
+ ]
+ }
+ },
+ "id": "SslSettings"
+ },
+ "ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "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.",
+ "type": "string"
+ },
+ "staticFile": {
+ "description": "Static file content to be served for this error.",
+ "type": "string"
+ }
+ },
+ "id": "ErrorHandler"
+ },
+ "Network": {
+ "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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "instanceTag": {
+ "description": "Tag to apply to the VM instance during creation. for Only applicable in the App Engine flexible environment.",
+ "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 App Engine flexible environment application.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Google Compute Engine 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 in the App Engine flexible environment.",
"type": "object"
},
"Application": {
@@ -2256,6 +2369,8 @@
"type": "string"
},
"servingStatus": {
+ "description": "Serving status of this application.",
+ "type": "string",
"enumDescriptions": [
"Serving status is unspecified.",
"Application is serving.",
@@ -2267,9 +2382,7 @@
"SERVING",
"USER_DISABLED",
"SYSTEM_DISABLED"
- ],
- "description": "Serving status of this application.",
- "type": "string"
+ ]
},
"defaultHostname": {
"description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
@@ -2304,32 +2417,6 @@
},
"id": "Application"
},
- "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.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "instanceTag": {
- "description": "Tag to apply to the VM instance during creation. for Only applicable in the App Engine flexible environment.",
- "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 App Engine flexible environment application.",
- "type": "string"
- },
- "name": {
- "description": "Google Compute Engine 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",
@@ -2378,18 +2465,18 @@
"type": "string"
},
"availability": {
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
"enum": [
"UNSPECIFIED",
"RESIDENT",
"DYNAMIC"
],
"description": "Availability of the instance.@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
- ]
+ "type": "string"
},
"errors": {
"description": "Number of errors since this instance was started.@OutputOnly",
@@ -2419,6 +2506,10 @@
},
"LivenessCheck": {
"properties": {
+ "path": {
+ "description": "The request path.",
+ "type": "string"
+ },
"host": {
"description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
"type": "string"
@@ -2447,10 +2538,6 @@
"description": "The initial delay before starting to execute the checks.",
"format": "google-duration",
"type": "string"
- },
- "path": {
- "description": "The request path.",
- "type": "string"
}
},
"id": "LivenessCheck",
@@ -2458,8 +2545,6 @@
"type": "object"
},
"BatchUpdateIngressRulesRequest": {
- "description": "Request message for Firewall.BatchUpdateIngressRules.",
- "type": "object",
"properties": {
"ingressRules": {
"description": "A list of FirewallRules to replace the existing set.",
@@ -2469,7 +2554,39 @@
}
}
},
- "id": "BatchUpdateIngressRulesRequest"
+ "id": "BatchUpdateIngressRulesRequest",
+ "description": "Request message for Firewall.BatchUpdateIngressRules.",
+ "type": "object"
+ },
+ "Location": {
+ "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": {
+ "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"
},
"NetworkUtilization": {
"description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.",
@@ -2498,40 +2615,15 @@
},
"id": "NetworkUtilization"
},
- "Location": {
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object",
- "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 location.",
- "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{\"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"
- },
"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": {
+ "checkInterval": {
+ "description": "Interval between health checks.",
+ "format": "google-duration",
+ "type": "string"
+ },
"timeout": {
"description": "Time before the health check is considered failed.",
"format": "google-duration",
@@ -2559,11 +2651,6 @@
"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"
@@ -2572,21 +2659,6 @@
"description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
"type": "object",
"properties": {
- "failureThreshold": {
- "description": "Number of consecutive failed checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "timeout": {
- "description": "Time before the check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "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",
- "type": "string"
- },
"path": {
"description": "The request path.",
"type": "string"
@@ -2604,13 +2676,26 @@
"description": "Interval between health checks.",
"format": "google-duration",
"type": "string"
+ },
+ "failureThreshold": {
+ "description": "Number of consecutive failed checks required before removing traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "timeout": {
+ "description": "Time before the check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "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",
+ "type": "string"
}
},
"id": "ReadinessCheck"
},
"StandardSchedulerSettings": {
- "description": "Scheduler settings for standard environment.",
- "type": "object",
"properties": {
"targetThroughputUtilization": {
"description": "Target throughput utilization ratio to maintain when scaling",
@@ -2633,7 +2718,9 @@
"type": "number"
}
},
- "id": "StandardSchedulerSettings"
+ "id": "StandardSchedulerSettings",
+ "description": "Scheduler settings for standard environment.",
+ "type": "object"
},
"DebugInstanceRequest": {
"description": "Request message for Instances.DebugInstance.",
@@ -2680,8 +2767,8 @@
"type": "object",
"properties": {
"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"
},
"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",
@@ -2689,16 +2776,16 @@
"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"
+ "$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."
+ "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.",
@@ -2713,8 +2800,8 @@
"$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"
+ "$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.",
@@ -2729,6 +2816,8 @@
"type": "string"
},
"servingStatus": {
+ "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.",
@@ -2738,23 +2827,25 @@
"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."
},
+ "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": {
+ "description": "Machine resources for this version. Only applicable for VM runtimes.",
+ "$ref": "Resources"
+ },
"inboundServices": {
"enumDescriptions": [
"Not specified.",
@@ -2784,10 +2875,6 @@
]
}
},
- "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",
@@ -2812,8 +2899,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.",
@@ -2839,8 +2926,8 @@
"$ref": "LivenessCheck"
},
"network": {
- "$ref": "Network",
- "description": "Extra network settings. Only applicable in the App Engine flexible environment."
+ "description": "Extra network settings. Only applicable in the App Engine flexible environment.",
+ "$ref": "Network"
},
"betaSettings": {
"additionalProperties": {
@@ -2869,9 +2956,18 @@
"properties": {},
"id": "RepairApplicationRequest"
},
+ "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"
+ },
"CertificateRawData": {
- "description": "An SSL certificate obtained from a certificate authority.",
- "type": "object",
"properties": {
"publicCertificate": {
"description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: \u003cpre\u003e -----BEGIN CERTIFICATE----- \u003ccertificate_value\u003e -----END CERTIFICATE----- \u003c/pre\u003e",
@@ -2882,18 +2978,28 @@
"type": "string"
}
},
- "id": "CertificateRawData"
+ "id": "CertificateRawData",
+ "description": "An SSL certificate obtained from a certificate authority.",
+ "type": "object"
},
- "BuildInfo": {
- "description": "Google Cloud Container Builder build information.",
+ "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": {
- "cloudBuildId": {
- "description": "The Google Cloud Container Builder build id. Example: \"f966068f-08b2-42c8-bdfe-74137dff2bf9\"",
+ "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"
+ },
+ "mimeType": {
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
"type": "string"
}
},
- "id": "BuildInfo"
+ "id": "FileInfo"
},
"ScriptHandler": {
"description": "Executes a script to handle the request that matches the URL pattern.",
@@ -2906,45 +3012,28 @@
},
"id": "ScriptHandler"
},
- "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"
- },
- "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"
- },
"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": {
- "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": {
+ "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
+ "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.",
"type": "object",
"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 no diversion will occur.",
@@ -2956,17 +3045,15 @@
"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"
+ ]
},
"allocations": {
- "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service 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 service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service 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"
@@ -2975,15 +3062,6 @@
"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"
- },
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
"type": "array",
@@ -2996,22 +3074,51 @@
"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",
+ "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",
+ "type": "string"
}
},
"id": "OperationMetadataV1Beta"
},
+ "ListIngressRulesResponse": {
+ "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"
+ }
+ }
+ },
+ "id": "ListIngressRulesResponse",
+ "description": "Response message for Firewall.ListIngressRules.",
+ "type": "object"
+ },
"ListServicesResponse": {
+ "description": "Response message for Services.ListServices.",
+ "type": "object",
"properties": {
"services": {
"description": "The services belonging to the requested application.",
@@ -3025,32 +3132,48 @@
"type": "string"
}
},
- "id": "ListServicesResponse",
- "description": "Response message for Services.ListServices.",
- "type": "object"
+ "id": "ListServicesResponse"
},
- "ListIngressRulesResponse": {
+ "Deployment": {
+ "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "type": "object",
"properties": {
- "ingressRules": {
- "description": "The ingress FirewallRules for this application.",
- "type": "array",
- "items": {
- "$ref": "FirewallRule"
- }
+ "zip": {
+ "$ref": "ZipInfo",
+ "description": "The zip file for this deployment, if this is a zip deployment."
},
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
+ "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": {
+ "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": "ListIngressRulesResponse",
- "description": "Response message for Firewall.ListIngressRules.",
- "type": "object"
+ "id": "Deployment"
},
"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",
@@ -3062,69 +3185,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"
},
- "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": {
- "description": "Google Cloud Container Builder build information.",
- "$ref": "BuildInfo"
- },
- "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"
- }
- }
- },
- "id": "Deployment",
- "description": "Code and application artifacts used to deploy a version to App Engine.",
- "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.",
@@ -3134,11 +3199,44 @@
}
}
},
- "id": "BatchUpdateIngressRulesResponse"
+ "id": "BatchUpdateIngressRulesResponse",
+ "description": "Response message for Firewall.UpdateAllIngressRules.",
+ "type": "object"
+ },
+ "Volume": {
+ "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",
+ "type": "number"
+ },
+ "name": {
+ "description": "Unique name for the volume.",
+ "type": "string"
+ }
+ },
+ "id": "Volume"
},
"ManagedCertificate": {
+ "description": "A certificate managed by App Engine.",
+ "type": "object",
"properties": {
"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",
@@ -3149,16 +3247,7 @@
"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 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."
- ]
+ "type": "string"
},
"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",
@@ -3166,47 +3255,47 @@
"type": "string"
}
},
- "id": "ManagedCertificate",
- "description": "A certificate managed by App Engine.",
- "type": "object"
+ "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"
}
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
}
},
"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"
}
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
}
},
- "id": "ListDomainMappingsResponse"
+ "id": "ListDomainMappingsResponse",
+ "description": "Response message for DomainMappings.ListDomainMappings.",
+ "type": "object"
},
"OperationMetadataV1Alpha": {
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object",
"properties": {
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
@@ -3220,14 +3309,14 @@
"format": "google-datetime",
"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"
},
+ "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"
@@ -3242,9 +3331,7 @@
"type": "string"
}
},
- "id": "OperationMetadataV1Alpha",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
+ "id": "OperationMetadataV1Alpha"
},
"UrlDispatchRule": {
"description": "Rules to match an HTTP request and dispatch that request to a service.",
@@ -3266,6 +3353,8 @@
"id": "UrlDispatchRule"
},
"ListVersionsResponse": {
+ "description": "Response message for Versions.ListVersions.",
+ "type": "object",
"properties": {
"versions": {
"description": "The versions belonging to the requested service.",
@@ -3279,9 +3368,7 @@
"type": "string"
}
},
- "id": "ListVersionsResponse",
- "description": "Response message for Versions.ListVersions.",
- "type": "object"
+ "id": "ListVersionsResponse"
},
"ListAuthorizedDomainsResponse": {
"description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
@@ -3301,34 +3388,15 @@
},
"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": {
"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"
+ "$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.",
@@ -3342,55 +3410,31 @@
}
}
},
- "id": "DomainMapping"
+ "id": "DomainMapping",
+ "description": "A domain serving an App Engine application.",
+ "type": "object"
},
- "ZipInfo": {
- "description": "The zip file information for a zip deployment.",
+ "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": {
- "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'.",
+ "scriptPath": {
+ "description": "Path to the script from the application root directory.",
"type": "string"
}
},
- "id": "ZipInfo"
+ "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"
- },
- "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",
@@ -3421,91 +3465,54 @@
"type": "string"
},
"cpuUtilization": {
- "$ref": "CpuUtilization",
- "description": "Target scaling by CPU usage."
+ "description": "Target scaling by CPU usage.",
+ "$ref": "CpuUtilization"
+ },
+ "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": {
+ "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"
}
},
"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",
+ "ZipInfo": {
"properties": {
- "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",
+ "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"
},
- "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": {
- "$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"
- },
- "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"
- }
- }
- },
- "id": "AuthorizedCertificate"
- },
- "ResourceRecord": {
- "description": "A DNS resource record.",
- "type": "object",
- "properties": {
- "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"
- },
- "name": {
- "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
+ "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": "ResourceRecord"
+ "id": "ZipInfo",
+ "description": "The zip file information for a zip deployment.",
+ "type": "object"
}
},
"icons": {
@@ -3518,30 +3525,23 @@
"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"
}
}
}
},
- "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",
- "revision": "20171213",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "id": "appengine:v1beta",
- "title": "Google App Engine Admin API",
- "discoveryVersion": "v1",
- "ownerName": "Google"
+ "name": "appengine"
}
diff --git a/appengine/v1beta4/appengine-api.json b/appengine/v1beta4/appengine-api.json
index 18c0e85..a0e808d 100644
--- a/appengine/v1beta4/appengine-api.json
+++ b/appengine/v1beta4/appengine-api.json
@@ -1,457 +1,973 @@
{
- "schemas": {
- "ListLocationsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
+ "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"
+ }
+ }
+ }
+ },
+ "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": "20171213",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "id": "appengine:v1beta4",
+ "title": "Google App Engine Admin API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
+ "resources": {
+ "apps": {
+ "methods": {
+ "get": {
+ "path": "v1beta4/apps/{appsId}",
+ "id": "appengine.apps.get",
+ "description": "Gets information about an application.",
+ "response": {
+ "$ref": "Application"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": {
+ "description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}"
+ },
+ "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)",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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": "v1beta4/apps/{appsId}",
+ "id": "appengine.apps.patch",
+ "path": "v1beta4/apps/{appsId}"
+ },
+ "create": {
+ "id": "appengine.apps.create",
+ "path": "v1beta4/apps",
+ "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"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta4/apps"
+ }
+ },
+ "resources": {
"locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "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"
+ },
+ "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": "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"
+ },
+ "parameterOrder": [
+ "appsId",
+ "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": {
+ "appsId": {
+ "description": "Part of `name`. Resource name for the location.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "locationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ }
+ }
}
- }
- },
- "id": "ListLocationsResponse",
- "description": "The response message for Locations.ListLocations.",
- "type": "object"
- },
- "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"
- },
- "Version": {
- "description": "A Version resource is a specific set of source code and configuration files that are deployed into a module.",
- "type": "object",
- "properties": {
- "network": {
- "$ref": "Network",
- "description": "Extra network settings. Only applicable for VM runtimes."
},
- "betaSettings": {
- "additionalProperties": {
- "type": "string"
+ "modules": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
+ "required": true,
+ "type": "string"
+ },
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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."
+ },
+ "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": {
+ "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": {
+ "description": "Part of `name`. Name of the resource requested. 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"
+ }
+ },
+ "flatPath": "v1beta4/apps/{appsId}/modules",
+ "path": "v1beta4/apps/{appsId}/modules",
+ "id": "appengine.apps.modules.list",
+ "description": "Lists all the modules in the application."
+ },
+ "patch": {
+ "request": {
+ "$ref": "Module"
+ },
+ "description": "Updates the configuration of the specified module.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/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/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": {
+ "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"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
+ "id": "appengine.apps.modules.patch"
+ }
},
- "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
- "type": "object"
- },
- "env": {
- "description": "App Engine execution environment to use for this version.Defaults to 1.",
- "type": "string"
- },
- "handlers": {
- "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
- "type": "array",
- "items": {
- "$ref": "UrlMap"
+ "resources": {
+ "versions": {
+ "resources": {
+ "instances": {
+ "methods": {
+ "delete": {
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.modules.versions.instances.delete",
+ "description": "Stops a running instance.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "appsId": {
+ "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"
+ },
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "response": {
+ "$ref": "Instance"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "appsId": {
+ "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"
+ },
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "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}/versions/{versionsId}/instances/{instancesId}",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.modules.versions.instances.get",
+ "description": "Gets instance information."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/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": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ }
+ },
+ "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}/versions/{versionsId}/instances",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
+ "id": "appengine.apps.modules.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)."
+ },
+ "debug": {
+ "id": "appengine.apps.modules.versions.instances.debug",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "appsId": {
+ "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"
+ },
+ "instancesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "modulesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "versionsId": {
+ "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/{versionsId}/instances/{instancesId}:debug"
+ }
+ }
+ }
+ },
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "Version"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId"
+ ],
+ "httpMethod": "GET",
+ "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,
+ "type": "string",
+ "location": "path"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "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": "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."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListVersionsResponse"
+ },
+ "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"
+ },
+ "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"
+ },
+ "modulesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the List 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": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "id": "appengine.apps.modules.versions.list",
+ "description": "Lists the versions of a module."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "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"
+ },
+ "mask": {
+ "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/modules/default/versions/1.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
+ "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."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId",
+ "modulesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. 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}/versions",
+ "id": "appengine.apps.modules.versions.create",
+ "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
+ "request": {
+ "$ref": "Version"
+ },
+ "description": "Deploys code and resource files to a new version."
+ },
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "modulesId",
+ "versionsId"
+ ],
+ "httpMethod": "DELETE",
+ "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": {
+ "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": "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."
+ }
+ }
+ }
}
},
- "deployer": {
- "description": "Email address of the user who created this version.@OutputOnly",
- "type": "string"
- },
- "automaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "$ref": "AutomaticScaling"
- },
- "healthCheck": {
- "$ref": "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."
- },
- "threadsafe": {
- "description": "Whether multiple requests can be dispatched to this version at once.",
- "type": "boolean"
- },
- "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.",
- "$ref": "ManualScaling"
- },
- "name": {
- "description": "Full path to the Version resource in the API. Example: apps/myapp/modules/default/versions/v1.@OutputOnly",
- "type": "string"
- },
- "apiConfig": {
- "$ref": "ApiConfigHandler",
- "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."
- },
- "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"
- },
- "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": {
- "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."
- ],
- "enum": [
- "SERVING_STATUS_UNSPECIFIED",
- "SERVING",
- "STOPPED"
- ]
- },
- "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"
- },
- "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": {
- "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/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
- "format": "google-duration",
- "type": "string"
- },
- "libraries": {
- "description": "Configuration for third-party Python runtime libraries required by the application.Only returned in GET requests if view=FULL is set.",
- "type": "array",
- "items": {
- "$ref": "Library"
- }
- },
- "nobuildFilesRegex": {
- "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
- "type": "string"
- },
- "creationTime": {
- "description": "Time that this version was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "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": {
- "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
+ "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"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET",
+ "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": {
+ "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": "v1beta4/apps/{appsId}/operations",
+ "path": "v1beta4/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list"
+ },
+ "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",
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "operationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. The name of the operation resource.",
+ "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}/operations/{operationsId}"
+ }
}
}
- },
- "id": "Version"
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
},
- "RequestUtilization": {
- "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetRequestCountPerSec": {
- "description": "Target requests per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetConcurrentRequests": {
- "description": "Target number of concurrent requests.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "RequestUtilization"
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
},
- "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": {
- "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": [
- "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": {
- "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"
- },
- "script": {
- "$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": [
- "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."
- ]
- },
- "apiEndpoint": {
- "description": "Uses API Endpoints to handle requests.",
- "$ref": "ApiEndpointHandler"
- }
- },
- "id": "UrlMap"
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
},
- "EndpointsApiService": {
- "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",
- "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"
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
},
- "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": {
- "$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"
- }
- },
- "id": "Operation"
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
},
- "ApiConfigHandler": {
- "properties": {
- "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": {
- "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": {
- "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"
- },
- "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"
+ "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": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "schemas": {
"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"
},
"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.",
"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"
},
+ "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"
@@ -469,16 +985,12 @@
"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"
+ "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",
"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"
@@ -486,11 +998,13 @@
"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",
- "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"
+ "id": "FileInfo"
},
"BasicScaling": {
"properties": {
@@ -513,11 +1027,6 @@
"description": "Target scaling by disk usage. Only applicable for VM runtimes.",
"type": "object",
"properties": {
- "targetReadOpsPerSec": {
- "description": "Target ops read per second.",
- "format": "int32",
- "type": "integer"
- },
"targetReadBytesPerSec": {
"description": "Target bytes read per second.",
"format": "int32",
@@ -532,13 +1041,16 @@
"description": "Target bytes written per second.",
"format": "int32",
"type": "integer"
+ },
+ "targetReadOpsPerSec": {
+ "description": "Target ops read per second.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "DiskUtilization"
},
"CpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "type": "object",
"properties": {
"aggregationWindowLength": {
"description": "Period of time over which CPU utilization is calculated.",
@@ -551,21 +1063,14 @@
"type": "number"
}
},
- "id": "CpuUtilization"
+ "id": "CpuUtilization",
+ "description": "Target scaling by CPU usage.",
+ "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": {
- "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",
@@ -576,16 +1081,23 @@
},
"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",
"properties": {
- "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": "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"
@@ -597,11 +1109,13 @@
"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",
- "description": "Identity-Aware Proxy",
- "type": "object"
+ "id": "IdentityAwareProxy"
},
"ManualScaling": {
"properties": {
@@ -620,17 +1134,17 @@
"type": "object",
"properties": {
"shardBy": {
- "enum": [
- "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",
"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.",
"Diversion based on applying the modulus operation to a fingerprint of the IP address."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "COOKIE",
+ "IP"
]
},
"allocations": {
@@ -663,24 +1177,11 @@
"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"
},
- "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",
@@ -688,13 +1189,26 @@
"type": "string"
}
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
+ "insertTime": {
+ "description": "Time 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/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"
+ },
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
}
},
"id": "OperationMetadataV1Beta"
@@ -718,6 +1232,8 @@
"id": "ListModulesResponse"
},
"Resources": {
+ "description": "Machine resources for a version.",
+ "type": "object",
"properties": {
"volumes": {
"description": "User specified volumes.",
@@ -742,14 +1258,17 @@
"type": "number"
}
},
- "id": "Resources",
- "description": "Machine resources for a version.",
- "type": "object"
+ "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."
@@ -760,25 +1279,14 @@
"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": "Deployment",
+ "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "type": "object"
},
"Volume": {
- "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
- "type": "object",
"properties": {
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
- "type": "string"
- },
"sizeGb": {
"description": "Volume size in gigabytes.",
"format": "double",
@@ -787,9 +1295,15 @@
"name": {
"description": "Unique name for the volume.",
"type": "string"
+ },
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "type": "string"
}
},
- "id": "Volume"
+ "id": "Volume",
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
@@ -813,6 +1327,15 @@
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
+ "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"
+ },
"operationType": {
"description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
"type": "string"
@@ -829,15 +1352,6 @@
"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"
- },
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
}
},
"id": "OperationMetadata"
@@ -846,16 +1360,16 @@
"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"
}
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
}
},
"id": "ListInstancesResponse"
@@ -864,23 +1378,6 @@
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "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"
- }
- },
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
@@ -896,6 +1393,23 @@
"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"
}
},
"id": "OperationMetadataV1"
@@ -937,10 +1451,6 @@
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "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",
@@ -969,6 +1479,10 @@
"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"
@@ -999,17 +1513,32 @@
"description": "An Application resource contains the top-level configuration of an App Engine application.",
"type": "object",
"properties": {
+ "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 module 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"
},
- "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"
@@ -1026,28 +1555,11 @@
"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": "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 module 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"
},
"UrlDispatchRule": {
- "description": "Rules to match an HTTP request and dispatch that request to a module.",
- "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.",
@@ -1062,35 +1574,18 @@
"type": "string"
}
},
- "id": "UrlDispatchRule"
+ "id": "UrlDispatchRule",
+ "description": "Rules to match an HTTP request and dispatch that request to a module.",
+ "type": "object"
},
"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",
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
- "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"
- },
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
- "format": "uint32",
- "type": "integer"
- },
"availability": {
"enum": [
"UNSPECIFIED",
@@ -1105,9 +1600,10 @@
""
]
},
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. 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"
},
"requests": {
"description": "Number of requests since this instance was started.@OutputOnly",
@@ -1136,16 +1632,34 @@
"description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
- "vmUnlocked": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
+ "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/modules/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",
+ "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"
+ },
+ "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"
}
},
@@ -1155,16 +1669,16 @@
"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 module.",
"type": "array",
"items": {
"$ref": "Version"
}
- },
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
}
},
"id": "ListVersionsResponse"
@@ -1174,8 +1688,8 @@
"type": "object",
"properties": {
"split": {
- "$ref": "TrafficSplit",
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the module."
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the module.",
+ "$ref": "TrafficSplit"
},
"id": {
"description": "Relative name of the module within the application. Example: default.@OutputOnly",
@@ -1256,8 +1770,8 @@
"description": "Target scaling by CPU usage."
},
"diskUtilization": {
- "$ref": "DiskUtilization",
- "description": "Target scaling by disk usage."
+ "description": "Target scaling by disk usage.",
+ "$ref": "DiskUtilization"
}
},
"id": "AutomaticScaling"
@@ -1266,6 +1780,10 @@
"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": {
+ "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"
@@ -1289,10 +1807,6 @@
},
"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"
@@ -1301,13 +1815,6 @@
"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"
@@ -1323,14 +1830,24 @@
},
"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"
},
"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",
@@ -1345,19 +1862,24 @@
"description": "Target packets received per second.",
"format": "int32",
"type": "integer"
- },
- "targetReceivedBytesPerSec": {
- "description": "Target bytes received per second.",
- "format": "int32",
- "type": "integer"
}
},
- "id": "NetworkUtilization"
+ "id": "NetworkUtilization",
+ "description": "Target scaling by network usage. Only applicable for VM runtimes.",
+ "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": {
+ "checkInterval": {
+ "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"
+ },
"unhealthyThreshold": {
"description": "Number of consecutive failed health checks required before removing traffic.",
"format": "uint32",
@@ -1380,30 +1902,22 @@
"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"
- },
- "timeout": {
- "description": "Time before the health check is considered failed.",
- "format": "google-duration",
- "type": "string"
}
},
- "id": "HealthCheck"
+ "id": "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"
},
"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"
},
"SourceReference": {
"description": "Reference to a particular snapshot of the source tree used to build and deploy the application.",
@@ -1424,10 +1938,6 @@
"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",
- "type": "string"
- },
"insertTime": {
"description": "Timestamp that this operation was created.@OutputOnly",
"format": "google-datetime",
@@ -1445,11 +1955,17 @@
"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"
}
},
"id": "OperationMetadataV1Beta5"
},
"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\".",
@@ -1460,8 +1976,429 @@
"type": "string"
}
},
- "id": "Library",
- "description": "Third-party Python runtime library that is required by the application.",
+ "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"
+ },
+ "Version": {
+ "description": "A Version resource is a specific set of source code and configuration files that are deployed into a module.",
+ "type": "object",
+ "properties": {
+ "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/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "libraries": {
+ "description": "Configuration for third-party Python runtime libraries required by the application.Only returned in GET requests if view=FULL is set.",
+ "type": "array",
+ "items": {
+ "$ref": "Library"
+ }
+ },
+ "nobuildFilesRegex": {
+ "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
+ "type": "string"
+ },
+ "creationTime": {
+ "description": "Time that this version was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "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": "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."
+ },
+ "betaSettings": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
+ "type": "object"
+ },
+ "env": {
+ "description": "App Engine execution environment to use for this version.Defaults to 1.",
+ "type": "string"
+ },
+ "handlers": {
+ "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
+ "type": "array",
+ "items": {
+ "$ref": "UrlMap"
+ }
+ },
+ "deployer": {
+ "description": "Email address of the user who created this version.@OutputOnly",
+ "type": "string"
+ },
+ "automaticScaling": {
+ "$ref": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
+ },
+ "healthCheck": {
+ "$ref": "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."
+ },
+ "threadsafe": {
+ "description": "Whether multiple requests can be dispatched to this version at once.",
+ "type": "boolean"
+ },
+ "manualScaling": {
+ "$ref": "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."
+ },
+ "name": {
+ "description": "Full path to the Version resource in the API. Example: apps/myapp/modules/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. 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": {
+ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.",
+ "$ref": "Deployment"
+ },
+ "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": {
+ "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"
+ }
+ }
+ },
+ "id": "Version"
+ },
+ "RequestUtilization": {
+ "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "targetRequestCountPerSec": {
+ "description": "Target requests per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetConcurrentRequests": {
+ "description": "Target number of concurrent requests.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "RequestUtilization"
+ },
+ "UrlMap": {
+ "properties": {
+ "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": {
+ "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"
+ },
+ "script": {
+ "$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": {
+ "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": {
+ "$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": {
+ "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."
+ ],
+ "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"
+ ]
+ }
+ },
+ "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": {
+ "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": {
+ "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"
+ },
+ "ApiConfigHandler": {
+ "properties": {
+ "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": {
+ "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": {
+ "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."
+ ],
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ]
+ },
+ "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"
}
},
@@ -1471,942 +2408,5 @@
},
"protocol": "rest",
"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",
- "revision": "20171213",
- "id": "appengine:v1beta4",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "title": "Google App Engine Admin API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
- "resources": {
- "apps": {
- "methods": {
- "get": {
- "description": "Gets information about an application.",
- "response": {
- "$ref": "Application"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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": {
- "description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}",
- "path": "v1beta4/apps/{appsId}",
- "id": "appengine.apps.get"
- },
- "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": {
- "modules": {
- "resources": {
- "versions": {
- "methods": {
- "delete": {
- "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": {
- "modulesId": {
- "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"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}"
- },
- "get": {
- "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"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "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": {
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string"
- },
- "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}"
- },
- "list": {
- "id": "appengine.apps.modules.versions.list",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "description": "Lists the versions of a module.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "response": {
- "$ref": "ListVersionsResponse"
- },
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
- "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"
- },
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the List 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": "v1beta4/apps/{appsId}/modules/{modulesId}/versions"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "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 resource to update. Example: apps/myapp/modules/default/versions/1.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}",
- "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."
- },
- "create": {
- "id": "appengine.apps.modules.versions.create",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions",
- "request": {
- "$ref": "Version"
- },
- "description": "Deploys code and resource files to a new version.",
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "modulesId": {
- "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/modules/default.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions"
- }
- },
- "resources": {
- "instances": {
- "methods": {
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId",
- "instancesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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"
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "modulesId": {
- "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": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.modules.versions.instances.debug",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug"
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "modulesId": {
- "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"
- },
- "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"
- },
- "instancesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.modules.versions.instances.delete",
- "description": "Stops a running instance."
- },
- "get": {
- "response": {
- "$ref": "Instance"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "modulesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "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/modules/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"
- }
- },
- "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}/versions/{versionsId}/instances/{instancesId}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.modules.versions.instances.get",
- "description": "Gets instance information."
- },
- "list": {
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "parameterOrder": [
- "appsId",
- "modulesId",
- "versionsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.",
- "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"
- },
- "modulesId": {
- "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/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.modules.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)."
- }
- }
- }
- }
- }
- },
- "methods": {
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. 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}",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "id": "appengine.apps.modules.delete",
- "description": "Deletes the specified module and all enclosed versions."
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "response": {
- "$ref": "Module"
- },
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.",
- "required": true,
- "type": "string"
- },
- "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}",
- "id": "appengine.apps.modules.get",
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "description": "Gets the current configuration of the specified module."
- },
- "list": {
- "response": {
- "$ref": "ListModulesResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "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"
- }
- },
- "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",
- "path": "v1beta4/apps/{appsId}/modules",
- "id": "appengine.apps.modules.list",
- "description": "Lists all the modules in the application."
- },
- "patch": {
- "path": "v1beta4/apps/{appsId}/modules/{modulesId}",
- "id": "appengine.apps.modules.patch",
- "description": "Updates the configuration of the specified module.",
- "request": {
- "$ref": "Module"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "modulesId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/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/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": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "mask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}"
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "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.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. The name of the operation's parent resource.",
- "required": true,
- "type": "string",
- "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/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta4/apps/{appsId}/operations"
- },
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "operationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation resource.",
- "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}/operations/{operationsId}",
- "path": "v1beta4/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."
- }
- }
- },
- "locations": {
- "methods": {
- "list": {
- "description": "Lists information about the supported locations for this service.",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "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"
- },
- "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"
- ],
- "flatPath": "v1beta4/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list",
- "path": "v1beta4/apps/{appsId}/locations"
- },
- "get": {
- "path": "v1beta4/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "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": {
- "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"
- }
- },
- "flatPath": "v1beta4/apps/{appsId}/locations/{locationsId}"
- }
- }
- }
- }
- }
- },
- "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": {
- "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": {
- "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": {
- "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"
- },
- "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"
- }
- }
+ "baseUrl": "https://appengine.googleapis.com/"
}
diff --git a/appengine/v1beta5/appengine-api.json b/appengine/v1beta5/appengine-api.json
index 580d92f..3f168f3 100644
--- a/appengine/v1beta5/appengine-api.json
+++ b/appengine/v1beta5/appengine-api.json
@@ -1,16 +1,22 @@
{
+ "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": "v1beta5",
"baseUrl": "https://appengine.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/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"
}
}
}
@@ -23,9 +29,9 @@
"ownerDomain": "google.com",
"name": "appengine",
"batchPath": "batch",
- "revision": "20171213",
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
"id": "appengine:v1beta5",
+ "revision": "20171213",
"title": "Google App Engine Admin API",
"ownerName": "Google",
"discoveryVersion": "v1",
@@ -33,6 +39,8 @@
"apps": {
"methods": {
"get": {
+ "path": "v1beta5/apps/{appsId}",
+ "id": "appengine.apps.get",
"description": "Gets information about an application.",
"response": {
"$ref": "Application"
@@ -41,6 +49,9 @@
"appsId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"ensureResourcesExist": {
"location": "query",
@@ -48,37 +59,35 @@
"type": "boolean"
},
"appsId": {
- "location": "path",
"description": "Part of `name`. Name of the application to get. Example: apps/myapp.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}",
- "path": "v1beta5/apps/{appsId}",
- "id": "appengine.apps.get"
+ "flatPath": "v1beta5/apps/{appsId}"
},
"patch": {
+ "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)",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId"
- ],
"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"
+ "type": "string",
+ "location": "path"
},
"mask": {
"description": "Standard field mask for the set of fields to be updated.",
@@ -89,459 +98,66 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}",
- "id": "appengine.apps.patch",
- "path": "v1beta5/apps/{appsId}"
+ ]
},
"create": {
+ "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/).",
"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"
- }
+ "httpMethod": "POST"
}
},
"resources": {
- "locations": {
- "methods": {
- "list": {
- "description": "Lists information about the supported locations for this service.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "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": {
- "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"
- },
- "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": "v1beta5/apps/{appsId}/locations",
- "path": "v1beta5/apps/{appsId}/locations",
- "id": "appengine.apps.locations.list"
- },
- "get": {
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "httpMethod": "GET",
- "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": "v1beta5/apps/{appsId}/locations/{locationsId}",
- "path": "v1beta5/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
- "description": "Get information about a location."
- }
- }
- },
"services": {
- "methods": {
- "delete": {
- "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"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.delete",
- "description": "Deletes the specified service and all enclosed versions."
- },
- "get": {
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.get",
- "description": "Gets the current configuration of the specified service.",
- "response": {
- "$ref": "Service"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "GET",
- "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/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- },
- "list": {
- "flatPath": "v1beta5/apps/{appsId}/services",
- "path": "v1beta5/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": {
- "description": "Part of `name`. Name of the resource requested. 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"
- ]
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "PATCH",
- "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": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "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/v1beta5/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/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"
- },
- "mask": {
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "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"
- }
- }
- },
"resources": {
"versions": {
- "resources": {
- "instances": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Instance"
- },
- "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"
- ],
- "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": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "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"
- }
- },
- "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",
- "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).",
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "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.",
- "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"
- },
- "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"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
- "id": "appengine.apps.services.versions.instances.list",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances"
- },
- "debug": {
- "path": "v1beta5/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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "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": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug"
- },
- "delete": {
- "description": "Stops a running instance.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "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"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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}"
- }
- }
- }
- },
"methods": {
+ "create": {
+ "request": {
+ "$ref": "Version"
+ },
+ "description": "Deploys new code and resource files to a new version.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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. For example: \"apps/myapp/services/default\".",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.create",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions"
+ },
"delete": {
"description": "Deletes an existing version.",
"response": {
@@ -561,16 +177,16 @@
"type": "string"
},
"servicesId": {
+ "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",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -581,7 +197,7 @@
"id": "appengine.apps.services.versions.delete"
},
"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"
},
@@ -590,12 +206,6 @@
"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 `name`. See documentation of `appsId`.",
@@ -604,17 +214,17 @@
"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"
},
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
"view": {
"location": "query",
"enum": [
@@ -625,9 +235,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": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.get",
"path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.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."
},
"list": {
"response": {
@@ -638,11 +254,6 @@
"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": {
"location": "path",
@@ -651,32 +262,37 @@
"type": "string"
},
"appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
"required": true,
"type": "string",
- "location": "path"
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default."
},
"pageToken": {
- "description": "Continuation token for fetching the next page of results.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results."
},
"pageSize": {
+ "location": "query",
"description": "Maximum results to return per page.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"view": {
+ "location": "query",
"enum": [
"BASIC",
"FULL"
],
"description": "Controls the set of fields returned in the List response.",
- "type": "string",
- "location": "query"
+ "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",
"path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
"id": "appengine.apps.services.versions.list",
@@ -693,17 +309,11 @@
],
"httpMethod": "PATCH",
"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"
+ "type": "string",
+ "location": "path"
},
"versionsId": {
"location": "path",
@@ -716,6 +326,12 @@
"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"
}
},
"scopes": [
@@ -728,48 +344,360 @@
"$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."
- },
- "create": {
- "request": {
- "$ref": "Version"
- },
- "description": "Deploys new code and resource files to a new version.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
+ }
+ },
+ "resources": {
+ "instances": {
+ "methods": {
+ "delete": {
+ "id": "appengine.apps.services.versions.instances.delete",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "description": "Stops a running instance.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "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. 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"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
},
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/services/default\".",
- "required": true,
- "type": "string",
- "location": "path"
+ "get": {
+ "response": {
+ "$ref": "Instance"
+ },
+ "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"
+ ],
+ "parameters": {
+ "versionsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`."
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1."
+ },
+ "instancesId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`."
+ }
+ },
+ "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",
+ "description": "Gets instance information."
+ },
+ "list": {
+ "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).",
+ "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": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. 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": {
+ "location": "query",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/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"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "POST",
+ "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 requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`."
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "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"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
- "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create"
+ }
}
}
}
+ },
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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 requested. Example: apps/myapp/services/default.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "id": "appengine.apps.services.delete",
+ "path": "v1beta5/apps/{appsId}/services/{servicesId}",
+ "description": "Deletes the specified service and all enclosed versions."
+ },
+ "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",
+ "description": "Gets the current configuration of the specified service."
+ },
+ "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 `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"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/services",
+ "path": "v1beta5/apps/{appsId}/services",
+ "id": "appengine.apps.services.list"
+ },
+ "patch": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "mask": {
+ "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/v1beta5/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/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"
+ }
+ },
+ "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"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "httpMethod": "PATCH"
+ }
}
},
"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",
"parameterOrder": [
"appsId"
@@ -778,27 +706,27 @@
"$ref": "ListOperationsResponse"
},
"parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
"appsId": {
+ "location": "path",
"description": "Part of `name`. The name of the operation's parent resource.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"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"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
+ "type": "integer"
}
},
"scopes": [
@@ -808,13 +736,9 @@
],
"flatPath": "v1beta5/apps/{appsId}/operations",
"id": "appengine.apps.operations.list",
- "path": "v1beta5/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."
+ "path": "v1beta5/apps/{appsId}/operations"
},
"get": {
- "path": "v1beta5/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"
},
@@ -823,18 +747,65 @@
"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",
- "location": "path"
+ "type": "string"
},
"operationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`."
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/operations/{operationsId}",
+ "path": "v1beta5/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."
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameters": {
+ "appsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable."
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "The standard list page token."
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
@@ -842,7 +813,42 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1beta5/apps/{appsId}/operations/{operationsId}"
+ "flatPath": "v1beta5/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list",
+ "path": "v1beta5/apps/{appsId}/locations"
+ },
+ "get": {
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "appsId",
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1beta5/apps/{appsId}/locations/{locationsId}",
+ "path": "v1beta5/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get",
+ "description": "Get information about a location."
}
}
}
@@ -850,26 +856,11 @@
}
},
"parameters": {
- "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",
- "location": "query"
+ "default": "true"
},
"fields": {
"location": "query",
@@ -877,31 +868,29 @@
"type": "string"
},
"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\")."
},
"$.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",
@@ -913,346 +902,48 @@
"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": {
+ "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",
- "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"
+ },
+ "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"
},
- "pp": {
+ "bearer_token": {
"location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
}
},
"schemas": {
- "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": {
- "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"
- },
- "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 an401 HTTP status code and an error message."
- ]
- },
- "script": {
- "$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": {
- "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 action given in auth_fail_action is taken."
- ],
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ]
- }
- },
- "id": "UrlMap"
- },
- "ApiConfigHandler": {
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.",
- "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.",
- "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 an401 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"
- },
- "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 action given in 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"
- },
- "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": {
- "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"
- },
- "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"
- },
- "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"
- },
- "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": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object"
- }
- },
- "id": "StaticFilesHandler"
- },
- "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"
- },
- "DiskUtilization": {
- "properties": {
- "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"
- },
- "targetWriteBytesPerSec": {
- "description": "Target bytes written per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DiskUtilization",
- "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
- "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"
- },
"CpuUtilization": {
"description": "Target scaling by CPU usage.",
"type": "object",
@@ -1271,13 +962,7 @@
"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",
@@ -1290,37 +975,45 @@
}
},
"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 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"
+ "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",
"properties": {
- "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": "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"
+ "type": "string",
+ "description": "OAuth2 client ID to use for the authentication flow."
},
"oauth2ClientSecretSha256": {
"description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
"type": "string"
+ },
+ "enabled": {
+ "type": "boolean",
+ "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."
}
},
- "id": "IdentityAwareProxy"
+ "id": "IdentityAwareProxy",
+ "description": "Identity-Aware Proxy",
+ "type": "object"
},
"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.",
@@ -1328,15 +1021,13 @@
"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"
},
"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": {
- "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.",
@@ -1346,7 +1037,9 @@
"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": {
"additionalProperties": {
@@ -1357,11 +1050,10 @@
"type": "object"
}
},
- "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"
+ "id": "TrafficSplit"
},
"LocationMetadata": {
+ "id": "LocationMetadata",
"description": "Metadata for the given google.cloud.location.Location.",
"type": "object",
"properties": {
@@ -1370,23 +1062,15 @@
"type": "boolean"
},
"standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
- "type": "boolean"
+ "type": "boolean",
+ "description": "App Engine Standard Environment is available in the given location.@OutputOnly"
}
- },
- "id": "LocationMetadata"
+ }
},
"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"
- },
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
"type": "array",
@@ -1410,11 +1094,18 @@
"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",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
+ "id": "OperationMetadataV1Beta"
},
"ListServicesResponse": {
"description": "Response message for Services.ListServices.",
@@ -1435,17 +1126,9 @@
"id": "ListServicesResponse"
},
"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": "Volumes mounted within the app container.",
"type": "array",
@@ -1457,19 +1140,27 @@
"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"
+ "id": "Resources"
},
"Deployment": {
"description": "Code and application artifacts used to deploy a version to App Engine.",
"type": "object",
"properties": {
"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"
+ "$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.",
@@ -1498,8 +1189,8 @@
"type": "number"
},
"name": {
- "description": "Unique name for the volume.",
- "type": "string"
+ "type": "string",
+ "description": "Unique name for the volume."
},
"volumeType": {
"description": "Underlying volume type, e.g. 'tmpfs'.",
@@ -1509,44 +1200,48 @@
"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": {
- "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"
},
"split": {
- "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
- "$ref": "TrafficSplit"
+ "$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 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."
},
"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",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
+ "id": "ListOperationsResponse"
},
"OperationMetadata": {
"properties": {
+ "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",
@@ -1561,16 +1256,12 @@
"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",
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
"type": "string"
}
},
@@ -1579,8 +1270,6 @@
"type": "object"
},
"ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "type": "object",
"properties": {
"instances": {
"description": "The instances belonging to the requested version.",
@@ -1594,7 +1283,9 @@
"type": "string"
}
},
- "id": "ListInstancesResponse"
+ "id": "ListInstancesResponse",
+ "description": "Response message for Instances.ListInstances.",
+ "type": "object"
},
"ErrorHandler": {
"description": "Custom static error page to be served when an error occurs.",
@@ -1630,7 +1321,14 @@
"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",
@@ -1658,24 +1356,14 @@
"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"
}
},
- "id": "OperationMetadataV1",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
+ "id": "OperationMetadataV1"
},
"OperationMetadataV1Alpha": {
+ "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",
@@ -1683,6 +1371,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"
@@ -1705,11 +1398,10 @@
"type": "string"
}
},
- "id": "OperationMetadataV1Alpha",
- "description": "Metadata for the given google.longrunning.Operation.",
- "type": "object"
+ "id": "OperationMetadataV1Alpha"
},
"Network": {
+ "type": "object",
"properties": {
"forwardedPorts": {
"description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
@@ -1732,13 +1424,19 @@
}
},
"id": "Network",
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "type": "object"
+ "description": "Extra network settings. Only applicable for VM runtimes."
},
"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.@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ }
+ },
"defaultHostname": {
"description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly",
"type": "string"
@@ -1747,13 +1445,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"
@@ -1774,40 +1472,99 @@
"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"
- }
}
},
"id": "Application"
},
"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"
+ "type": "string",
+ "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\"."
},
"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": {
+ "type": "string",
+ "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."
}
},
- "id": "UrlDispatchRule",
- "description": "Rules to match an HTTP request and dispatch that request to a service.",
- "type": "object"
+ "id": "UrlDispatchRule"
},
"Instance": {
"description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
"type": "object",
"properties": {
+ "vmName": {
+ "type": "string",
+ "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "memoryUsage": {
+ "type": "string",
+ "description": "Total memory in use (bytes).@OutputOnly",
+ "format": "int64"
+ },
+ "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"
+ },
+ "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",
@@ -1821,72 +1578,6 @@
"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"
- },
- "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": {
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
- "description": "Availability of the instance.@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
- ]
- },
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
- "format": "uint32",
- "type": "integer"
}
},
"id": "Instance"
@@ -1895,30 +1586,30 @@
"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"
}
- },
- "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",
- "description": "Uses Google Cloud Endpoints to handle requests.",
- "type": "object"
+ "id": "ApiEndpointHandler"
},
"AutomaticScaling": {
"description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
@@ -1930,46 +1621,46 @@
"type": "integer"
},
"networkUtilization": {
- "description": "Target scaling by network usage.",
- "$ref": "NetworkUtilization"
- },
- "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"
+ "$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": {
+ "type": "string",
+ "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"
+ },
"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"
+ "$ref": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
},
"diskUtilization": {
- "$ref": "DiskUtilization",
- "description": "Target scaling by disk usage."
+ "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": {
+ "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"
},
- "requestUtilization": {
- "description": "Target scaling by request utilization.",
- "$ref": "RequestUtilization"
- },
"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",
@@ -1988,19 +1679,19 @@
"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"
},
"name": {
- "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
- "type": "string"
+ "type": "string",
+ "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\""
},
"locationId": {
- "description": "The canonical id for this location. For example: \"us-east1\".",
- "type": "string"
+ "type": "string",
+ "description": "The canonical id for this location. For example: \"us-east1\"."
},
"metadata": {
"additionalProperties": {
@@ -2033,9 +1724,9 @@
"type": "integer"
},
"targetReceivedBytesPerSec": {
+ "type": "integer",
"description": "Target bytes received per second.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
}
},
"id": "NetworkUtilization"
@@ -2044,13 +1735,9 @@
"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": {
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
- "type": "boolean"
- },
"host": {
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
- "type": "string"
+ "type": "string",
+ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\""
},
"healthyThreshold": {
"description": "Number of consecutive successful health checks required before receiving traffic.",
@@ -2063,9 +1750,9 @@
"type": "integer"
},
"checkInterval": {
+ "type": "string",
"description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
+ "format": "google-duration"
},
"timeout": {
"description": "Time before the health check is considered failed.",
@@ -2076,52 +1763,58 @@
"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"
}
},
"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"
+ },
+ "revisionId": {
+ "type": "string",
+ "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\""
}
},
- "id": "SourceReference"
+ "id": "SourceReference",
+ "description": "Reference to a particular snapshot of the source tree used to build and deploy the application."
},
"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",
- "description": "Request message for Instances.DebugInstance.",
- "type": "object"
+ "id": "DebugInstanceRequest"
},
"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"
+ },
+ "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"
+ "id": "Library"
},
"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",
@@ -2146,24 +1839,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"
@@ -2183,35 +1874,70 @@
"description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
"type": "object",
"properties": {
+ "libraries": {
+ "description": "Configuration for third-party Python runtime libraries required by the application.Only returned in GET requests if view=FULL is set.",
+ "type": "array",
+ "items": {
+ "$ref": "Library"
+ }
+ },
+ "nobuildFilesRegex": {
+ "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
+ "type": "string"
+ },
+ "creationTime": {
+ "description": "Time that this version was created.@OutputOnly",
+ "format": "google-datetime",
+ "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."
+ },
+ "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": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set."
+ },
"network": {
"$ref": "Network",
"description": "Extra network settings. Only applicable for VM runtimes."
},
"betaSettings": {
- "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
+ "type": "object"
},
"env": {
"description": "App Engine execution environment to use for this version.Defaults to 1.",
"type": "string"
},
"handlers": {
- "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
"type": "array",
"items": {
"$ref": "UrlMap"
- }
+ },
+ "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set."
},
"deployer": {
"description": "Email address of the user who created this version.@OutputOnly",
"type": "string"
},
"automaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "$ref": "AutomaticScaling"
+ "$ref": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
},
"diskUsageBytes": {
"description": "Total size of version files hosted on App Engine disk in bytes.@OutputOnly",
@@ -2227,28 +1953,28 @@
"type": "boolean"
},
"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"
+ "$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"
+ "$ref": "ApiConfigHandler",
+ "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."
},
"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"
},
"vm": {
- "description": "Whether to deploy this version in a container on a virtual machine.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether to deploy this version in a container on a virtual machine."
},
"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"
+ "type": "string",
+ "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."
},
"servingStatus": {
"enumDescriptions": [
@@ -2273,22 +1999,6 @@
"$ref": "Deployment"
},
"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.",
@@ -2299,7 +2009,23 @@
"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",
+ "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"
+ ]
+ }
},
"resources": {
"$ref": "Resources",
@@ -2316,41 +2042,6 @@
"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/v1/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
"format": "google-duration",
"type": "string"
- },
- "libraries": {
- "description": "Configuration for third-party Python runtime libraries required by the application.Only returned in GET requests if view=FULL is set.",
- "type": "array",
- "items": {
- "$ref": "Library"
- }
- },
- "nobuildFilesRegex": {
- "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
- "type": "string"
- },
- "creationTime": {
- "description": "Time that this version was created.@OutputOnly",
- "format": "google-datetime",
- "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"
- },
- "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": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.",
- "type": "object"
}
},
"id": "Version"
@@ -2365,18 +2056,327 @@
"type": "integer"
},
"targetConcurrentRequests": {
+ "type": "integer",
"description": "Target number of concurrent requests.",
+ "format": "int32"
+ }
+ },
+ "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": {
+ "properties": {
+ "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": {
+ "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 action given in auth_fail_action is taken."
+ ],
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "description": "Level of login required to access this resource."
+ },
+ "apiEndpoint": {
+ "$ref": "ApiEndpointHandler",
+ "description": "Uses API Endpoints to handle requests."
+ },
+ "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"
+ },
+ "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": {
+ "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."
+ ],
+ "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."
+ },
+ "script": {
+ "description": "Executes a script to handle the request that matches this URL pattern.",
+ "$ref": "ScriptHandler"
+ }
+ },
+ "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": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "URL to serve the endpoint at.",
+ "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": {
+ "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."
+ ],
+ "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"
+ },
+ "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 action given in auth_fail_action is taken."
+ ]
+ }
+ },
+ "id": "ApiConfigHandler",
+ "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers."
+ },
+ "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": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "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."
+ },
+ "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"
+ },
+ "FileInfo": {
+ "properties": {
+ "sha1Sum": {
+ "description": "The SHA1 hash of the file, in hex.",
+ "type": "string"
+ },
+ "mimeType": {
+ "type": "string",
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage."
+ },
+ "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",
+ "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"
+ },
+ "StaticFilesHandler": {
+ "properties": {
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "applicationReadable": {
+ "type": "boolean",
+ "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."
+ },
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "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"
+ },
+ "mimeType": {
+ "type": "string",
+ "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."
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "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"
+ },
+ "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"
+ },
+ "DiskUtilization": {
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "targetReadBytesPerSec": {
+ "description": "Target bytes read per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteOpsPerSec": {
+ "description": "Target ops written per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteBytesPerSec": {
+ "description": "Target bytes written per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReadOpsPerSec": {
+ "description": "Target ops read per second.",
"format": "int32",
"type": "integer"
}
},
- "id": "RequestUtilization"
+ "id": "DiskUtilization"
+ },
+ "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"
}
- },
- "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"
+ }
}
diff --git a/bigquerydatatransfer/v1/bigquerydatatransfer-api.json b/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
index 446ce4c..d6d3f95 100644
--- a/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
+++ b/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
@@ -1,632 +1,4 @@
{
- "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": "20171208",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "ScheduleTransferRunsResponse": {
- "description": "A response to schedule transfer runs for a time range.",
- "type": "object",
- "properties": {
- "runs": {
- "description": "The transfer runs that were scheduled.",
- "type": "array",
- "items": {
- "$ref": "TransferRun"
- }
- }
- },
- "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": {
- "properties": {
- "messageTime": {
- "description": "Time when message was logged.",
- "format": "google-datetime",
- "type": "string"
- },
- "severity": {
- "enumDescriptions": [
- "No severity specified.",
- "Informational message.",
- "Warning message.",
- "Error message."
- ],
- "enum": [
- "MESSAGE_SEVERITY_UNSPECIFIED",
- "INFO",
- "WARNING",
- "ERROR"
- ],
- "description": "Message severity.",
- "type": "string"
- },
- "messageText": {
- "description": "Message text.",
- "type": "string"
- }
- },
- "id": "TransferMessage",
- "description": "Represents a user facing message for a particular data transfer run.",
- "type": "object"
- },
- "ListDataSourcesResponse": {
- "description": "Returns list of supported data sources and their metadata.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListDataSourcesRequest.page_token`\nto request the next page of list results.",
- "type": "string"
- },
- "dataSources": {
- "description": "List of supported data sources and their transfer settings.",
- "type": "array",
- "items": {
- "$ref": "DataSource"
- }
- }
- },
- "id": "ListDataSourcesResponse"
- },
- "DataSourceParameter": {
- "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": {
- "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",
- "items": {
- "$ref": "DataSourceParameter"
- }
- },
- "maxValue": {
- "description": "For integer and double values specifies maxminum allowed value.",
- "format": "double",
- "type": "number"
- },
- "type": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "STRING",
- "INTEGER",
- "DOUBLE",
- "BOOLEAN",
- "RECORD",
- "PLUS_PAGE"
- ],
- "description": "Parameter type.",
- "type": "string",
- "enumDescriptions": [
- "Type unspecified.",
- "String parameter.",
- "Integer parameter (64-bits).\nWill be serialized to json as string.",
- "Double precision floating point parameter.",
- "Boolean parameter.",
- "Record parameter.",
- "Page ID for a Google+ Page."
- ]
- },
- "recurse": {
- "description": "If set to true, schema should be taken from the parent with the same\nparameter_id. Only applicable when parameter type is RECORD.",
- "type": "boolean"
- },
- "description": {
- "description": "Parameter description.",
- "type": "string"
- },
- "allowedValues": {
- "description": "All possible values for the parameter.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "validationHelpUrl": {
- "description": "URL to a help document to further explain the naming requirements.",
- "type": "string"
- },
- "minValue": {
- "description": "For integer and double values specifies minimum allowed value.",
- "format": "double",
- "type": "number"
- },
- "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"
- }
- },
- "id": "DataSourceParameter"
- },
- "ListTransferRunsResponse": {
- "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",
- "description": "The returned list of pipelines in the project.",
- "type": "object"
- },
- "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"
- },
- "ListTransferConfigsResponse": {
- "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`ListTransferConfigsRequest.page_token`\nto request the next page of list results.",
- "type": "string"
- },
- "transferConfigs": {
- "description": "Output only. The stored pipeline transfer configurations.",
- "type": "array",
- "items": {
- "$ref": "TransferConfig"
- }
- }
- },
- "id": "ListTransferConfigsResponse"
- },
- "DataSource": {
- "properties": {
- "defaultSchedule": {
- "description": "Default data transfer schedule.\nExamples of valid schedules include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.",
- "type": "string"
- },
- "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"
- },
- "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",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "description": "Data source resource name.",
- "type": "string"
- },
- "minimumScheduleInterval": {
- "description": "The minimum interval between two consecutive scheduled runs.",
- "format": "google-duration",
- "type": "string"
- },
- "clientId": {
- "description": "Data source client id which should be used to receive refresh token.\nWhen not supplied, no offline credentials are populated for data transfer.",
- "type": "string"
- },
- "authorizationType": {
- "enum": [
- "AUTHORIZATION_TYPE_UNSPECIFIED",
- "AUTHORIZATION_CODE",
- "GOOGLE_PLUS_AUTHORIZATION_CODE"
- ],
- "description": "Indicates the type of authorization.",
- "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.",
- "type": "boolean"
- },
- "displayName": {
- "description": "User friendly data source name.",
- "type": "string"
- },
- "updateDeadlineSeconds": {
- "description": "The number of seconds to wait for an update from the data source\nbefore BigQuery marks the transfer as failed.",
- "format": "int32",
- "type": "integer"
- },
- "dataRefreshType": {
- "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.",
- "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Allows custom values to be set for each transfer\nconfig."
- ],
- "enum": [
- "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.",
- "type": "array",
- "items": {
- "$ref": "DataSourceParameter"
- }
- },
- "helpUrl": {
- "description": "Url for the help document for this data source.",
- "type": "string"
- }
- },
- "id": "DataSource",
- "description": "Represents data source metadata. Metadata is sufficient to\nrender UI and request proper OAuth tokens.",
- "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"
- },
- "ScheduleTransferRunsRequest": {
- "properties": {
- "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"
- },
- "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"
- },
- "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"
- },
- "TransferConfig": {
- "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": {
- "nextRunTime": {
- "description": "Output only. Next time when data transfer will run.",
- "format": "google-datetime",
- "type": "string"
- },
- "disabled": {
- "description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer.",
- "type": "boolean"
- },
- "schedule": {
- "description": "Data transfer schedule.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified times are in UTC.\nExamples of valid format:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.\nSee more explanation about the format here:\nhttps://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\nNOTE: the granularity should be at least 8 hours, or less frequent.",
- "type": "string"
- },
- "updateTime": {
- "description": "Output only. Data transfer modification time. Ignored by server on input.",
- "format": "google-datetime",
- "type": "string"
- },
- "dataRefreshWindowDays": {
- "description": "The number of days to look back to automatically refresh the data.\nFor example, if `data_refresh_window_days = 10`, then every day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. Set the value to 0\nto use the default value.",
- "format": "int32",
- "type": "integer"
- },
- "dataSourceId": {
- "description": "Data source id. Cannot be changed once data transfer is created.",
- "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",
- "RUNNING",
- "SUCCEEDED",
- "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"
- },
- "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"
- },
- "displayName": {
- "description": "User specified display name for the data transfer.",
- "type": "string"
- }
- },
- "id": "TransferConfig"
- },
- "TransferRun": {
- "properties": {
- "params": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "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": {
- "$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": {
- "enum": [
- "TRANSFER_STATE_UNSPECIFIED",
- "PENDING",
- "RUNNING",
- "SUCCEEDED",
- "FAILED",
- "CANCELLED"
- ],
- "description": "Data transfer run state. Ignored for input requests.",
- "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."
- ]
- },
- "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"
- },
- "name": {
- "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.",
- "type": "string"
- }
- },
- "id": "TransferRun",
- "description": "Represents a data transfer run.\nNext id: 25",
- "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"
- },
- "CheckValidCredsResponse": {
- "description": "A response indicating whether the credentials exist and are valid.",
- "type": "object",
- "properties": {
- "hasValidCreds": {
- "description": "If set to `true`, the credentials exist and are valid.",
- "type": "boolean"
- }
- },
- "id": "CheckValidCredsResponse"
- }
- },
- "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": "BigQuery Data Transfer",
"auth": {
"oauth2": {
@@ -656,6 +28,10 @@
"locations": {
"methods": {
"list": {
+ "flatPath": "v1/projects/{projectsId}/locations",
+ "path": "v1/{+name}/locations",
+ "id": "bigquerydatatransfer.projects.locations.list",
+ "description": "Lists information about the supported locations for this service.",
"response": {
"$ref": "ListLocationsResponse"
},
@@ -670,16 +46,16 @@
],
"parameters": {
"name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
"description": "The resource that owns the locations collection, if applicable.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
},
"pageToken": {
+ "location": "query",
"description": "The standard list page token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"location": "query",
@@ -688,19 +64,13 @@
"type": "integer"
},
"filter": {
- "location": "query",
"description": "The standard list filter.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
- },
- "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"
@@ -716,50 +86,25 @@
],
"parameters": {
"name": {
+ "location": "path",
"description": "Resource name for the location.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}"
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.locations.get"
}
},
"resources": {
"dataSources": {
"methods": {
- "checkValidCreds": {
- "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/[^/]+/locations/[^/]+/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}/locations/{locationsId}/dataSources/{dataSourcesId}: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"
- }
- },
"get": {
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.locations.dataSources.get",
+ "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.",
"response": {
"$ref": "DataSource"
},
@@ -781,13 +126,9 @@
"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",
- "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering."
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}"
},
"list": {
- "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
"response": {
"$ref": "ListDataSourcesResponse"
},
@@ -795,16 +136,176 @@
"parent"
],
"httpMethod": "GET",
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "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"
+ },
+ "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}/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."
+ },
+ "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": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
+ "location": "path",
+ "description": "The data source in the form:\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}:checkValidCreds",
+ "path": "v1/{+name}:checkValidCreds",
+ "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds"
+ }
+ }
+ },
+ "transferConfigs": {
+ "methods": {
+ "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."
+ },
+ "patch": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
+ "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": {
+ "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",
+ "location": "query"
+ },
+ "updateMask": {
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ }
+ },
+ "delete": {
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListTransferConfigsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
"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"
+ "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": {
"description": "Page size. The default page size is the maximum value of 1000 results.",
@@ -813,90 +314,107 @@
"location": "query"
},
"parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path",
- "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
+ "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ },
+ "dataSourceIds": {
+ "description": "When specified, only configurations of requested data sources are returned.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources",
- "path": "v1/{+parent}/dataSources",
- "id": "bigquerydatatransfer.projects.locations.dataSources.list"
+ "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",
+ "path": "v1/{+parent}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.list",
+ "description": "Returns information about all data transfers in the project."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "parameters": {
+ "authorizationCode": {
+ "location": "query",
+ "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"
+ },
+ "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",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.create",
+ "path": "v1/{+parent}/transferConfigs",
+ "request": {
+ "$ref": "TransferConfig"
+ },
+ "description": "Creates a new data transfer configuration."
+ },
+ "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.",
+ "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"
}
- }
- },
- "transferConfigs": {
+ },
"resources": {
"runs": {
- "resources": {
- "transferLogs": {
- "methods": {
- "list": {
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list",
- "path": "v1/{+parent}/transferLogs",
- "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": {
- "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": {
- "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"
- }
- }
- }
- },
"methods": {
"delete": {
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete",
"path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete",
"description": "Deletes the specified transfer run.",
- "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "DELETE",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
@@ -913,6 +431,7 @@
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}"
},
"get": {
+ "description": "Returns information about the particular transfer run.",
"response": {
"$ref": "TransferRun"
},
@@ -920,6 +439,11 @@
"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}/transferConfigs/{config_id}/runs/{run_id}`",
@@ -929,19 +453,11 @@
"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}",
"path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get",
- "description": "Returns information about the particular transfer run."
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get"
},
"list": {
- "path": "v1/{+parent}/runs",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list",
"description": "Returns information about running and completed jobs.",
"response": {
"$ref": "ListTransferRunsResponse"
@@ -991,219 +507,75 @@
"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"
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs"
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs",
+ "path": "v1/{+parent}/runs",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list"
+ }
+ },
+ "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": {
+ "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": {
+ "location": "path",
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
+ "path": "v1/{+parent}/transferLogs",
+ "id": "bigquerydatatransfer.projects.locations.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/[^/]+/locations/[^/]+/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}/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": {
- "response": {
- "$ref": "ListTransferConfigsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "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}/locations/{locationsId}/transferConfigs",
- "path": "v1/{+parent}/transferConfigs",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.list",
- "description": "Returns information about all data transfers in the project."
- },
- "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/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
- "path": "v1/{+parent}/transferConfigs",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.create"
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ScheduleTransferRunsResponse"
- },
- "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",
- "id": "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns",
- "path": "v1/{+parent}:scheduleRuns"
- },
- "patch": {
- "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": {
- "updateMask": {
- "location": "query",
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "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.",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}"
- },
- "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."
- }
}
}
}
@@ -1211,9 +583,6 @@
"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"
},
@@ -1228,14 +597,17 @@
],
"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/[^/]+/dataSources/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/dataSources/[^/]+$"
}
},
- "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}"
+ "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}",
+ "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."
},
"list": {
"response": {
@@ -1245,6 +617,11 @@
"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": {
"pattern": "^projects/[^/]+$",
@@ -1259,27 +636,18 @@
"type": "string"
},
"pageSize": {
- "location": "query",
"description": "Page size. The default page size is the maximum value of 1000 results.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "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}/dataSources",
"path": "v1/{+parent}/dataSources",
"id": "bigquerydatatransfer.projects.dataSources.list",
"description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering."
},
"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"
},
@@ -1287,11 +655,6 @@
"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}`",
@@ -1301,42 +664,283 @@
"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}:checkValidCreds",
"path": "v1/{+name}:checkValidCreds",
- "id": "bigquerydatatransfer.projects.dataSources.checkValidCreds"
+ "id": "bigquerydatatransfer.projects.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."
}
}
},
"transferConfigs": {
+ "methods": {
+ "create": {
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "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",
+ "pattern": "^projects/[^/]+$"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/transferConfigs",
+ "path": "v1/{+parent}/transferConfigs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.create",
+ "request": {
+ "$ref": "TransferConfig"
+ },
+ "description": "Creates a new data transfer configuration."
+ },
+ "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"
+ },
+ "response": {
+ "$ref": "ScheduleTransferRunsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
+ "location": "path",
+ "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
+ "path": "v1/{+parent}:scheduleRuns",
+ "id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns"
+ },
+ "patch": {
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "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": {
+ "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/[^/]+/transferConfigs/[^/]+$",
+ "location": "path"
+ },
+ "authorizationCode": {
+ "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",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.patch",
+ "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
+ "request": {
+ "$ref": "TransferConfig"
+ }
+ },
+ "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}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.get"
+ },
+ "delete": {
+ "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.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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/[^/]+$"
+ }
+ }
+ },
+ "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",
+ "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": {
+ "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": {
+ "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "dataSourceIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "When specified, only configurations of requested data sources are returned.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs"
+ }
+ },
"resources": {
"runs": {
- "methods": {
- "delete": {
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete",
- "path": "v1/{+name}",
- "description": "Deletes the specified transfer run.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "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/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "location": "path"
+ "resources": {
+ "transferLogs": {
+ "methods": {
+ "list": {
+ "description": "Returns user facing log messages for the data transfer run.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListTransferLogsResponse"
+ },
+ "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": {
+ "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": {
+ "location": "query",
+ "description": "Page size. The default page size is the maximum value of 1000 results.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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
+ }
+ },
+ "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}/transferLogs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list",
+ "path": "v1/{+parent}/transferLogs"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}"
- },
+ }
+ }
+ },
+ "methods": {
"get": {
"response": {
"$ref": "TransferRun"
@@ -1365,38 +969,19 @@
"description": "Returns information about the particular transfer run."
},
"list": {
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.list",
- "path": "v1/{+parent}/runs",
- "description": "Returns information about running and completed jobs.",
- "httpMethod": "GET",
"response": {
"$ref": "ListTransferRunsResponse"
},
"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": {
- "runAttempt": {
- "enum": [
- "RUN_ATTEMPT_UNSPECIFIED",
- "LATEST"
- ],
- "description": "Indicates how run attempts are to be pulled.",
- "type": "string",
- "location": "query"
- },
- "parent": {
- "pattern": "^projects/[^/]+/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": {
"enum": [
"TRANSFER_STATE_UNSPECIFIED",
@@ -1412,285 +997,103 @@
"location": "query"
},
"pageSize": {
+ "location": "query",
"description": "Page size. The default page size is the maximum value of 1000 results.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
+ },
+ "runAttempt": {
+ "location": "query",
+ "enum": [
+ "RUN_ATTEMPT_UNSPECIFIED",
+ "LATEST"
+ ],
+ "description": "Indicates how run attempts are to be pulled.",
+ "type": "string"
+ },
+ "parent": {
+ "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",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$"
+ },
+ "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"
}
},
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs",
+ "path": "v1/{+parent}/runs",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.list",
+ "description": "Returns information about running and completed jobs."
+ },
+ "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",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
+ "https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs"
- }
- },
- "resources": {
- "transferLogs": {
- "methods": {
- "list": {
- "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": {
- "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"
- },
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
- "path": "v1/{+parent}/transferLogs",
- "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list",
- "description": "Returns user facing log messages for the data transfer run."
+ "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/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
+ "location": "path"
}
- }
+ },
+ "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
+ "path": "v1/{+name}",
+ "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete"
}
}
}
- },
- "methods": {
- "create": {
- "id": "bigquerydatatransfer.projects.transferConfigs.create",
- "path": "v1/{+parent}/transferConfigs",
- "request": {
- "$ref": "TransferConfig"
- },
- "description": "Creates a new data transfer configuration.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "TransferConfig"
- },
- "parameters": {
- "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"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs"
- },
- "scheduleRuns": {
- "response": {
- "$ref": "ScheduleTransferRunsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
- "location": "path",
- "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
- "path": "v1/{+parent}:scheduleRuns",
- "id": "bigquerydatatransfer.projects.transferConfigs.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"
- }
- },
- "get": {
- "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": {
- "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.get",
- "description": "Returns information about a data transfer config."
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "TransferConfig"
- },
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "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.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
- },
- "authorizationCode": {
- "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",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
- "id": "bigquerydatatransfer.projects.transferConfigs.patch",
- "path": "v1/{+name}",
- "request": {
- "$ref": "TransferConfig"
- },
- "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated."
- },
- "delete": {
- "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
- "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}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
- "path": "v1/{+name}",
- "id": "bigquerydatatransfer.projects.transferConfigs.delete"
- },
- "list": {
- "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": {
- "description": "Page size. The default page size is the maximum value of 1000 results.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
- "required": true,
- "type": "string"
- },
- "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",
- "path": "v1/{+parent}/transferConfigs",
- "id": "bigquerydatatransfer.projects.transferConfigs.list",
- "description": "Returns information about all data transfers in the project."
- }
}
}
}
}
},
"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": {
+ "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": {
+ "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",
@@ -1713,11 +1116,13 @@
"type": "string"
},
"callback": {
- "location": "query",
"description": "JSONP",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1726,16 +1131,9 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
+ ]
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -1744,40 +1142,642 @@
],
"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"
- },
- "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"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
}
},
"version": "v1",
- "baseUrl": "https://bigquerydatatransfer.googleapis.com/"
+ "baseUrl": "https://bigquerydatatransfer.googleapis.com/",
+ "servicePath": "",
+ "description": "Transfers data from partner SaaS applications to Google BigQuery on a scheduled, managed basis.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "id": "bigquerydatatransfer:v1",
+ "documentationLink": "https://cloud.google.com/bigquery/",
+ "revision": "20171216",
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "schemas": {
+ "DataSource": {
+ "description": "Represents data source metadata. Metadata is sufficient to\nrender UI and request proper OAuth tokens.",
+ "type": "object",
+ "properties": {
+ "defaultSchedule": {
+ "description": "Default data transfer schedule.\nExamples of valid schedules include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.",
+ "type": "string"
+ },
+ "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": {
+ "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",
+ "items": {
+ "type": "string"
+ }
+ },
+ "minimumScheduleInterval": {
+ "description": "The minimum interval for scheduler to schedule runs.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "clientId": {
+ "description": "Data source client id which should be used to receive refresh token.\nWhen not supplied, no offline credentials are populated for data transfer.",
+ "type": "string"
+ },
+ "authorizationType": {
+ "enum": [
+ "AUTHORIZATION_TYPE_UNSPECIFIED",
+ "AUTHORIZATION_CODE",
+ "GOOGLE_PLUS_AUTHORIZATION_CODE"
+ ],
+ "description": "Indicates the type of authorization.",
+ "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.",
+ "type": "boolean"
+ },
+ "displayName": {
+ "description": "User friendly data source name.",
+ "type": "string"
+ },
+ "updateDeadlineSeconds": {
+ "description": "The number of seconds to wait for an update from the data source\nbefore BigQuery marks the transfer as failed.",
+ "format": "int32",
+ "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.",
+ "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Allows custom values to be set for each transfer\nconfig."
+ ],
+ "enum": [
+ "DATA_REFRESH_TYPE_UNSPECIFIED",
+ "SLIDING_WINDOW",
+ "CUSTOM_SLIDING_WINDOW"
+ ]
+ },
+ "parameters": {
+ "description": "Data source parameters.",
+ "type": "array",
+ "items": {
+ "$ref": "DataSourceParameter"
+ }
+ },
+ "helpUrl": {
+ "description": "Url for the help document for this data source.",
+ "type": "string"
+ }
+ },
+ "id": "DataSource"
+ },
+ "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"
+ },
+ "ScheduleTransferRunsRequest": {
+ "description": "A request to schedule transfer runs for a time range.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ },
+ "Location": {
+ "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",
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object"
+ },
+ "TransferConfig": {
+ "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": {
+ "dataRefreshWindowDays": {
+ "description": "The number of days to look back to automatically refresh the data.\nFor example, if `data_refresh_window_days = 10`, then every day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. Set the value to 0\nto use the default value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "dataSourceId": {
+ "description": "Data source id. Cannot be changed once data transfer is created.",
+ "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",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "description": "Output only. State of the most recently updated transfer run.",
+ "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"
+ },
+ "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"
+ },
+ "params": {
+ "description": "Data transfer specific parameters.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
+ },
+ "datasetRegion": {
+ "description": "Output only. Region in which BigQuery dataset is located.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "User specified display name for the data transfer.",
+ "type": "string"
+ },
+ "nextRunTime": {
+ "description": "Output only. Next time when data transfer will run.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "disabled": {
+ "description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer.",
+ "type": "boolean"
+ },
+ "updateTime": {
+ "description": "Output only. Data transfer modification time. Ignored by server on input.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "schedule": {
+ "description": "Data transfer schedule.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified times are in UTC.\nExamples of valid format:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.\nSee more explanation about the format here:\nhttps://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\nNOTE: the granularity should be at least 8 hours, or less frequent.",
+ "type": "string"
+ }
+ },
+ "id": "TransferConfig"
+ },
+ "TransferRun": {
+ "description": "Represents a data transfer run.\nNext id: 27",
+ "type": "object",
+ "properties": {
+ "state": {
+ "enum": [
+ "TRANSFER_STATE_UNSPECIFIED",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "description": "Data transfer run state. Ignored for input requests.",
+ "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 run.\nTransfer run names have the form\n`projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.",
+ "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"
+ },
+ "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."
+ },
+ "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"
+ },
+ "updateTime": {
+ "description": "Output only. Last time the data transfer run state was updated.",
+ "format": "google-datetime",
+ "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"
+ }
+ },
+ "id": "TransferRun"
+ },
+ "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",
+ "properties": {},
+ "id": "CheckValidCredsRequest"
+ },
+ "CheckValidCredsResponse": {
+ "description": "A response indicating whether the credentials exist and are valid.",
+ "type": "object",
+ "properties": {
+ "hasValidCreds": {
+ "description": "If set to `true`, the credentials exist and are valid.",
+ "type": "boolean"
+ }
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "TransferRun"
+ }
+ }
+ },
+ "id": "ScheduleTransferRunsResponse"
+ },
+ "TransferMessage": {
+ "properties": {
+ "messageTime": {
+ "description": "Time when message was logged.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "severity": {
+ "enumDescriptions": [
+ "No severity specified.",
+ "Informational message.",
+ "Warning message.",
+ "Error message."
+ ],
+ "enum": [
+ "MESSAGE_SEVERITY_UNSPECIFIED",
+ "INFO",
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "Message severity.",
+ "type": "string"
+ },
+ "messageText": {
+ "description": "Message text.",
+ "type": "string"
+ }
+ },
+ "id": "TransferMessage",
+ "description": "Represents a user facing message for a particular data transfer run.",
+ "type": "object"
+ },
+ "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"
+ },
+ "ListDataSourcesResponse": {
+ "description": "Returns list of supported data sources and their metadata.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListDataSourcesRequest.page_token`\nto request the next page of list results.",
+ "type": "string"
+ },
+ "dataSources": {
+ "description": "List of supported data sources and their transfer settings.",
+ "type": "array",
+ "items": {
+ "$ref": "DataSource"
+ }
+ }
+ },
+ "id": "ListDataSourcesResponse"
+ },
+ "DataSourceParameter": {
+ "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"
+ },
+ "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"
+ },
+ "fields": {
+ "description": "When parameter is a record, describes child fields.",
+ "type": "array",
+ "items": {
+ "$ref": "DataSourceParameter"
+ }
+ },
+ "maxValue": {
+ "description": "For integer and double values specifies maxminum allowed value.",
+ "format": "double",
+ "type": "number"
+ },
+ "type": {
+ "description": "Parameter type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Type unspecified.",
+ "String parameter.",
+ "Integer parameter (64-bits).\nWill be serialized to json as string.",
+ "Double precision floating point parameter.",
+ "Boolean parameter.",
+ "Record parameter.",
+ "Page ID for a Google+ Page."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "STRING",
+ "INTEGER",
+ "DOUBLE",
+ "BOOLEAN",
+ "RECORD",
+ "PLUS_PAGE"
+ ]
+ },
+ "recurse": {
+ "description": "If set to true, schema should be taken from the parent with the same\nparameter_id. Only applicable when parameter type is RECORD.",
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Parameter description.",
+ "type": "string"
+ }
+ },
+ "id": "DataSourceParameter",
+ "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"
+ },
+ "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"
+ },
+ "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",
+ "properties": {
+ "nextPageToken": {
+ "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferConfigsRequest.page_token`\nto request the next page of list results.",
+ "type": "string"
+ },
+ "transferConfigs": {
+ "description": "Output only. The stored pipeline transfer configurations.",
+ "type": "array",
+ "items": {
+ "$ref": "TransferConfig"
+ }
+ }
+ },
+ "id": "ListTransferConfigsResponse"
+ }
+ },
+ "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"
+ }
}
diff --git a/bigquerydatatransfer/v1/bigquerydatatransfer-gen.go b/bigquerydatatransfer/v1/bigquerydatatransfer-gen.go
index 0e64bc0..d5a581b 100644
--- a/bigquerydatatransfer/v1/bigquerydatatransfer-gen.go
+++ b/bigquerydatatransfer/v1/bigquerydatatransfer-gen.go
@@ -317,8 +317,8 @@
// for the data source.
ManualRunsDisabled bool `json:"manualRunsDisabled,omitempty"`
- // MinimumScheduleInterval: The minimum interval between two consecutive
- // scheduled runs.
+ // MinimumScheduleInterval: The minimum interval for scheduler to
+ // schedule runs.
MinimumScheduleInterval string `json:"minimumScheduleInterval,omitempty"`
// Name: Data source resource name.
@@ -1134,7 +1134,7 @@
}
// TransferRun: Represents a data transfer run.
-// Next id: 25
+// Next id: 27
type TransferRun struct {
// DataSourceId: Output only. Data source id.
DataSourceId string `json:"dataSourceId,omitempty"`
diff --git a/classroom/v1/classroom-api.json b/classroom/v1/classroom-api.json
index 6d71122..b1e94f9 100644
--- a/classroom/v1/classroom-api.json
+++ b/classroom/v1/classroom-api.json
@@ -1,14 +1,22 @@
{
- "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://classroom.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
+ "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"
},
@@ -47,21 +55,6 @@
},
"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"
}
}
}
@@ -78,12 +71,77 @@
"documentationLink": "https://developers.google.com/classroom/",
"revision": "20171213",
"title": "Google Classroom API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
"invitations": {
"methods": {
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Identifier of the invitation to return.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/invitations/{id}",
+ "path": "v1/invitations/{id}",
+ "id": "classroom.invitations.get"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListInvitationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters",
+ "https://www.googleapis.com/auth/classroom.rosters.readonly"
+ ],
+ "parameters": {
+ "userId": {
+ "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",
+ "location": "query"
+ },
+ "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": {
+ "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",
+ "location": "query"
+ },
+ "courseId": {
+ "description": "Restricts returned invitations to those for a course with the specified\nidentifier.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "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."
+ },
"create": {
+ "path": "v1/invitations",
+ "id": "classroom.invitations.create",
"request": {
"$ref": "Invitation"
},
@@ -97,11 +155,10 @@
"scopes": [
"https://www.googleapis.com/auth/classroom.rosters"
],
- "flatPath": "v1/invitations",
- "path": "v1/invitations",
- "id": "classroom.invitations.create"
+ "flatPath": "v1/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.",
"response": {
"$ref": "Empty"
},
@@ -122,14 +179,141 @@
},
"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."
+ "id": "classroom.invitations.accept"
},
"delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "id"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ],
+ "parameters": {
+ "id": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Identifier of the invitation to delete."
+ }
+ },
"flatPath": "v1/invitations/{id}",
- "path": "v1/invitations/{id}",
"id": "classroom.invitations.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.",
+ "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."
+ }
+ }
+ },
+ "courses": {
+ "methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Course"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "flatPath": "v1/courses",
+ "id": "classroom.courses.create",
+ "path": "v1/courses",
+ "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."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Course"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ],
+ "flatPath": "v1/courses/{id}",
+ "id": "classroom.courses.get",
+ "path": "v1/courses/{id}",
+ "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": {
+ "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"
+ },
+ "updateMask": {
+ "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",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "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",
+ "response": {
+ "$ref": "Course"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "PATCH"
+ },
+ "update": {
+ "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",
+ "response": {
+ "$ref": "Course"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "PUT",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "flatPath": "v1/courses/{id}",
+ "path": "v1/courses/{id}",
+ "id": "classroom.courses.update"
+ },
+ "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.",
"response": {
"$ref": "Empty"
},
@@ -138,1148 +322,78 @@
],
"httpMethod": "DELETE",
"scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
+ "https://www.googleapis.com/auth/classroom.courses"
],
"parameters": {
"id": {
"location": "path",
- "description": "Identifier of the invitation to delete.",
- "required": true,
- "type": "string"
- }
- }
- },
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the invitation to return.",
+ "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/invitations/{id}",
- "path": "v1/invitations/{id}",
- "id": "classroom.invitations.get"
+ "flatPath": "v1/courses/{id}",
+ "path": "v1/courses/{id}",
+ "id": "classroom.courses.delete"
},
"list": {
- "parameters": {
- "userId": {
- "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",
- "location": "query"
- },
- "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": {
- "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",
- "location": "query"
- },
- "courseId": {
- "type": "string",
- "location": "query",
- "description": "Restricts returned invitations to those for a course with the specified\nidentifier."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters",
- "https://www.googleapis.com/auth/classroom.rosters.readonly"
- ],
- "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.",
"response": {
- "$ref": "ListInvitationsResponse"
+ "$ref": "ListCoursesResponse"
},
"parameterOrder": [],
- "httpMethod": "GET"
- }
- }
- },
- "courses": {
- "resources": {
- "courseWork": {
- "methods": {
- "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.",
- "response": {
- "$ref": "CourseWork"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "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"
- },
- "id": {
- "location": "path",
- "description": "Identifier of the coursework.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.students"
- ],
- "flatPath": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees"
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ],
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "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."
},
- "get": {
- "response": {
- "$ref": "CourseWork"
- },
- "parameterOrder": [
- "courseId",
- "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 course work.",
- "required": true,
- "type": "string",
- "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}/courseWork/{id}",
- "path": "v1/courses/{courseId}/courseWork/{id}",
- "id": "classroom.courses.courseWork.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."
+ "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"
},
- "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": {
- "updateMask": {
- "type": "string",
- "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"
- },
- "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"
- }
- },
- "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"
+ "teacherId": {
+ "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",
+ "location": "query"
},
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "id"
+ "courseStates": {
+ "location": "query",
+ "enum": [
+ "COURSE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "ARCHIVED",
+ "PROVISIONED",
+ "DECLINED",
+ "SUSPENDED"
],
- "httpMethod": "DELETE",
- "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 course work to delete.\nThis identifier is a Classroom-assigned identifier.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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.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."
+ "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.",
+ "type": "string",
+ "repeated": true
},
- "list": {
- "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.",
- "response": {
- "$ref": "ListCourseWorkResponse"
- },
- "parameterOrder": [
- "courseId"
- ],
- "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"
- },
- "orderBy": {
- "location": "query",
- "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"
- },
- "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": {
- "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": {
- "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",
- "repeated": true
- }
- },
- "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"
- ]
- },
- "create": {
- "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",
- "request": {
- "$ref": "CourseWork"
- },
- "response": {
- "$ref": "CourseWork"
- },
- "parameterOrder": [
- "courseId"
- ],
- "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"
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork",
- "path": "v1/courses/{courseId}/courseWork",
- "id": "classroom.courses.courseWork.create"
+ "studentId": {
+ "location": "query",
+ "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"
}
},
- "resources": {
- "studentSubmissions": {
- "methods": {
- "modifyAttachments": {
- "request": {
- "$ref": "ModifyAttachmentsRequest"
- },
- "description": "Modifies attachments of student submission.\n\nAttachments may only be added to student submissions belonging to course\nwork objects with a `workType` of `ASSIGNMENT`.\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, if the user is not permitted to modify\nattachments on the requested 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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "response": {
- "$ref": "StudentSubmission"
- },
- "parameters": {
- "courseId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
- },
- "id": {
- "location": "path",
- "description": "Identifier of the student submission.",
- "required": true,
- "type": "string"
- },
- "courseWorkId": {
- "description": "Identifier of the course work.",
- "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}:modifyAttachments",
- "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments"
- },
- "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": "ListStudentSubmissionsResponse"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId"
- ],
- "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"
- ],
- "parameters": {
- "userId": {
- "type": "string",
- "location": "query",
- "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"
- },
- "courseWorkId": {
- "location": "path",
- "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"
- },
- "courseId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
- },
- "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": {
- "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": {
- "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": {
- "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.",
- "type": "string",
- "repeated": true,
- "location": "query",
- "enum": [
- "SUBMISSION_STATE_UNSPECIFIED",
- "NEW",
- "CREATED",
- "TURNED_IN",
- "RETURNED",
- "RECLAIMED_BY_STUDENT"
- ]
- }
- },
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
- "id": "classroom.courses.courseWork.studentSubmissions.list"
- },
- "patch": {
- "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.",
- "response": {
- "$ref": "StudentSubmission"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "courseWorkId": {
- "description": "Identifier of the course work.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "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 student submission.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "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"
- }
- },
- "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}",
- "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": {
- "courseWorkId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the course work."
- },
- "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"
- }
- },
- "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": {
- "request": {
- "$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.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "httpMethod": "POST",
- "parameters": {
- "courseId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
- },
- "id": {
- "location": "path",
- "description": "Identifier of the student submission.",
- "required": true,
- "type": "string"
- },
- "courseWorkId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the course work."
- }
- },
- "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"
- },
- "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.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "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"
- },
- "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}:reclaim"
- },
- "turnIn": {
- "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
- "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
- "id": "classroom.courses.courseWork.studentSubmissions.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.",
- "request": {
- "$ref": "TurnInStudentSubmissionRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "courseWorkId",
- "id"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.coursework.me"
- ],
- "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 student submission.",
- "required": true,
- "type": "string"
- },
- "courseWorkId": {
- "location": "path",
- "description": "Identifier of the course work.",
- "required": true,
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "teachers": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Teacher"
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "userId": {
- "location": "path",
- "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"
- },
- "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}",
- "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": {
- "httpMethod": "GET",
- "parameterOrder": [
- "courseId"
- ],
- "response": {
- "$ref": "ListTeachersResponse"
- },
- "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"
- },
- "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": {
- "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"
- }
- },
- "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": {
- "flatPath": "v1/courses/{courseId}/teachers",
- "id": "classroom.courses.teachers.create",
- "path": "v1/courses/{courseId}/teachers",
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "courseId"
- ],
- "response": {
- "$ref": "Teacher"
- },
- "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"
- ]
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.rosters"
- ],
- "parameters": {
- "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"
- },
- "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}/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": {
- "modifyAssignees": {
- "response": {
- "$ref": "Announcement"
- },
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "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"
- },
- "id": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the announcement."
- }
- },
- "scopes": [
- "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": {
- "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 announcement.",
- "required": true,
- "type": "string"
- }
- },
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "courseId",
- "id"
- ],
- "response": {
- "$ref": "Announcement"
- }
- },
- "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": {
- "id": {
- "description": "Identifier of the announcement.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "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": {
- "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "courseId",
- "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": {
- "description": "Identifier of the announcement to delete.\nThis identifier is a Classroom-assigned identifier.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.announcements"
- ],
- "flatPath": "v1/courses/{courseId}/announcements/{id}",
- "id": "classroom.courses.announcements.delete",
- "path": "v1/courses/{courseId}/announcements/{id}",
- "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": {
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "courseId"
- ],
- "response": {
- "$ref": "ListAnnouncementsResponse"
- },
- "parameters": {
- "announcementStates": {
- "repeated": true,
- "location": "query",
- "enum": [
- "ANNOUNCEMENT_STATE_UNSPECIFIED",
- "PUBLISHED",
- "DRAFT",
- "DELETED"
- ],
- "description": "Restriction on the `state` of announcements returned.\nIf this argument is left unspecified, the default value is `PUBLISHED`.",
- "type": "string"
- },
- "orderBy": {
- "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"
- },
- "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": "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.announcements",
- "https://www.googleapis.com/auth/classroom.announcements.readonly"
- ],
- "flatPath": "v1/courses/{courseId}/announcements",
- "id": "classroom.courses.announcements.list",
- "path": "v1/courses/{courseId}/announcements"
- },
- "create": {
- "response": {
- "$ref": "Announcement"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.announcements"
- ],
- "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"
- }
- },
- "flatPath": "v1/courses/{courseId}/announcements",
- "path": "v1/courses/{courseId}/announcements",
- "id": "classroom.courses.announcements.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",
- "request": {
- "$ref": "Announcement"
- }
- }
- }
- },
- "students": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Student"
- },
- "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": {
- "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"
- }
- },
- "flatPath": "v1/courses/{courseId}/students/{userId}",
- "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."
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "courseId"
- ],
- "response": {
- "$ref": "ListStudentsResponse"
- },
- "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": {
- "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",
- "location": "query"
- },
- "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}/students",
- "id": "classroom.courses.students.list",
- "path": "v1/courses/{courseId}/students",
- "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."
- },
- "create": {
- "response": {
- "$ref": "Student"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "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.",
- "required": true,
- "type": "string"
- },
- "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"
- }
- },
- "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}/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."
- },
- "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.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "courseId",
- "userId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "userId": {
- "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",
- "location": "path"
- },
- "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.rosters"
- ],
- "flatPath": "v1/courses/{courseId}/students/{userId}",
- "id": "classroom.courses.students.delete",
- "path": "v1/courses/{courseId}/students/{userId}"
- }
- }
- },
+ "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."
+ }
+ },
+ "resources": {
"topics": {
"methods": {
"get": {
+ "description": "Returns a topic.\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 topic, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or topic does not exist.",
"response": {
"$ref": "Topic"
},
@@ -1289,29 +403,24 @@
],
"httpMethod": "GET",
"parameters": {
- "id": {
- "location": "path",
- "description": "Identifier of the topic.",
- "required": true,
- "type": "string"
- },
"courseId": {
- "location": "path",
"description": "Identifier of the course.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
+ },
+ "id": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Identifier of the topic."
}
},
"flatPath": "v1/courses/{courseId}/topics/{id}",
"path": "v1/courses/{courseId}/topics/{id}",
- "id": "classroom.courses.topics.get",
- "description": "Returns a topic.\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 topic, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or topic does not exist."
+ "id": "classroom.courses.topics.get"
},
"list": {
- "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.",
"response": {
"$ref": "ListTopicResponse"
},
@@ -1320,11 +429,6 @@
],
"httpMethod": "GET",
"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": {
"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.",
@@ -1332,80 +436,26 @@
"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"
+ "type": "string",
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
+ },
+ "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"
}
- }
+ },
+ "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."
}
}
},
"aliases": {
"methods": {
- "list": {
- "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": {
- "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": {
- "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",
- "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."
- },
- "create": {
- "description": "Creates an alias for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create the\nalias or for access errors.\n* `NOT_FOUND` if the course does not exist.\n* `ALREADY_EXISTS` if the alias already exists.\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 access a domain-scoped alias).",
- "request": {
- "$ref": "CourseAlias"
- },
- "response": {
- "$ref": "CourseAlias"
- },
- "parameterOrder": [
- "courseId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "parameters": {
- "courseId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the course to alias.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
- }
- },
- "flatPath": "v1/courses/{courseId}/aliases",
- "path": "v1/courses/{courseId}/aliases",
- "id": "classroom.courses.aliases.create"
- },
"delete": {
"path": "v1/courses/{courseId}/aliases/{alias}",
"id": "classroom.courses.aliases.delete",
@@ -1429,216 +479,1162 @@
"location": "path"
},
"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}"
+ },
+ "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",
+ "parameters": {
+ "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"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses",
+ "https://www.googleapis.com/auth/classroom.courses.readonly"
+ ],
+ "flatPath": "v1/courses/{courseId}/aliases",
+ "path": "v1/courses/{courseId}/aliases",
+ "id": "classroom.courses.aliases.list"
+ },
+ "create": {
+ "response": {
+ "$ref": "CourseAlias"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.courses"
+ ],
+ "parameters": {
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course to alias.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/aliases",
+ "path": "v1/courses/{courseId}/aliases",
+ "id": "classroom.courses.aliases.create",
+ "description": "Creates an alias for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create the\nalias or for access errors.\n* `NOT_FOUND` if the course does not exist.\n* `ALREADY_EXISTS` if the alias already exists.\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 access a domain-scoped alias).",
+ "request": {
+ "$ref": "CourseAlias"
+ }
+ }
+ }
+ },
+ "courseWork": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ],
+ "parameters": {
+ "id": {
+ "location": "path",
+ "description": "Identifier of the course work to delete.\nThis identifier is a Classroom-assigned identifier.",
+ "required": true,
+ "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}/aliases/{alias}"
+ "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."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListCourseWorkResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "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": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
+ },
+ "orderBy": {
+ "location": "query",
+ "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"
+ },
+ "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": {
+ "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": {
+ "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",
+ "enum": [
+ "COURSE_WORK_STATE_UNSPECIFIED",
+ "PUBLISHED",
+ "DRAFT",
+ "DELETED"
+ ]
+ }
+ },
+ "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."
+ },
+ "create": {
+ "response": {
+ "$ref": "CourseWork"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork",
+ "path": "v1/courses/{courseId}/courseWork",
+ "id": "classroom.courses.courseWork.create",
+ "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",
+ "request": {
+ "$ref": "CourseWork"
+ }
+ },
+ "modifyAssignees": {
+ "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",
+ "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"
+ }
+ },
+ "get": {
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}",
+ "path": "v1/courses/{courseId}/courseWork/{id}",
+ "id": "classroom.courses.courseWork.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": "CourseWork"
+ },
+ "parameterOrder": [
+ "courseId",
+ "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 course work.",
+ "required": true,
+ "type": "string",
+ "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"
+ ]
+ },
+ "patch": {
+ "id": "classroom.courses.courseWork.patch",
+ "path": "v1/courses/{courseId}/courseWork/{id}",
+ "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.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "response": {
+ "$ref": "CourseWork"
+ },
+ "parameters": {
+ "updateMask": {
+ "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",
+ "location": "query"
+ },
+ "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 course work.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ],
+ "flatPath": "v1/courses/{courseId}/courseWork/{id}"
+ }
+ },
+ "resources": {
+ "studentSubmissions": {
+ "methods": {
+ "return": {
+ "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": {
+ "location": "path",
+ "description": "Identifier of the student submission.",
+ "required": true,
+ "type": "string"
+ },
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
+ "id": "classroom.courses.courseWork.studentSubmissions.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"
+ }
+ },
+ "reclaim": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "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"
+ },
+ "id": {
+ "location": "path",
+ "description": "Identifier of the student submission.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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": {
+ "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.",
+ "request": {
+ "$ref": "TurnInStudentSubmissionRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me"
+ ],
+ "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": {
+ "location": "path",
+ "description": "Identifier of the student submission.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
+ "id": "classroom.courses.courseWork.studentSubmissions.turnIn"
+ },
+ "modifyAttachments": {
+ "response": {
+ "$ref": "StudentSubmission"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.coursework.me",
+ "https://www.googleapis.com/auth/classroom.coursework.students"
+ ],
+ "parameters": {
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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 student submission.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
+ "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
+ "description": "Modifies attachments of student submission.\n\nAttachments may only be added to student submissions belonging to course\nwork objects with a `workType` of `ASSIGNMENT`.\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, if the user is not permitted to modify\nattachments on the requested 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": "ModifyAttachmentsRequest"
+ }
+ },
+ "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": "ListStudentSubmissionsResponse"
+ },
+ "parameterOrder": [
+ "courseId",
+ "courseWorkId"
+ ],
+ "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"
+ ],
+ "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"
+ },
+ "states": {
+ "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.",
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "SUBMISSION_STATE_UNSPECIFIED",
+ "NEW",
+ "CREATED",
+ "TURNED_IN",
+ "RETURNED",
+ "RECLAIMED_BY_STUDENT"
+ ]
+ },
+ "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"
+ },
+ "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": {
+ "location": "path",
+ "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"
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ },
+ "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": "query"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
+ "id": "classroom.courses.courseWork.studentSubmissions.list"
+ },
+ "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.",
+ "response": {
+ "$ref": "StudentSubmission"
+ },
+ "parameterOrder": [
+ "courseId",
+ "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"
+ ],
+ "parameters": {
+ "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"
+ },
+ "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}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "id": "classroom.courses.courseWork.studentSubmissions.get"
+ },
+ "patch": {
+ "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": {
+ "courseWorkId": {
+ "description": "Identifier of the course work.",
+ "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"
+ },
+ "id": {
+ "description": "Identifier of the student submission.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "type": "string",
+ "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"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
+ "id": "classroom.courses.courseWork.studentSubmissions.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"
+ }
+ }
+ }
}
}
- }
- },
- "methods": {
- "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",
- "path": "v1/courses",
- "id": "classroom.courses.create"
},
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Course"
- },
- "parameters": {
- "id": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ],
- "flatPath": "v1/courses/{id}",
- "id": "classroom.courses.get",
- "path": "v1/courses/{id}"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "id"
- ],
- "response": {
- "$ref": "Course"
- },
- "parameters": {
- "id": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
+ "teachers": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "courseId",
+ "userId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "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"
+ },
+ "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.rosters"
+ ],
+ "flatPath": "v1/courses/{courseId}/teachers/{userId}",
+ "id": "classroom.courses.teachers.delete",
+ "path": "v1/courses/{courseId}/teachers/{userId}",
+ "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."
},
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "flatPath": "v1/courses/{id}",
- "id": "classroom.courses.patch",
- "path": "v1/courses/{id}",
- "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": {
- "response": {
- "$ref": "Course"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "PUT",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "flatPath": "v1/courses/{id}",
- "path": "v1/courses/{id}",
- "id": "classroom.courses.update",
- "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"
- },
- "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"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses"
- ],
- "flatPath": "v1/courses/{id}",
- "id": "classroom.courses.delete",
- "path": "v1/courses/{id}"
- },
- "list": {
- "response": {
- "$ref": "ListCoursesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "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": {
- "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"
- },
- "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": {
- "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",
- "enum": [
- "COURSE_STATE_UNSPECIFIED",
- "ACTIVE",
- "ARCHIVED",
- "PROVISIONED",
- "DECLINED",
- "SUSPENDED"
+ "get": {
+ "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.",
+ "response": {
+ "$ref": "Teacher"
+ },
+ "parameterOrder": [
+ "courseId",
+ "userId"
+ ],
+ "httpMethod": "GET",
+ "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": {
+ "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"
+ }
+ },
+ "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"
]
+ },
+ "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.",
+ "response": {
+ "$ref": "ListTeachersResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "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": {
+ "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": {
+ "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",
+ "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"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/teachers",
+ "path": "v1/courses/{courseId}/teachers",
+ "id": "classroom.courses.teachers.list"
+ },
+ "create": {
+ "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.",
+ "request": {
+ "$ref": "Teacher"
+ },
+ "response": {
+ "$ref": "Teacher"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "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": {
+ "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}/teachers",
+ "path": "v1/courses/{courseId}/teachers",
+ "id": "classroom.courses.teachers.create"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.courses",
- "https://www.googleapis.com/auth/classroom.courses.readonly"
- ],
- "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."
+ }
+ },
+ "announcements": {
+ "methods": {
+ "modifyAssignees": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "response": {
+ "$ref": "Announcement"
+ },
+ "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.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements"
+ ],
+ "flatPath": "v1/courses/{courseId}/announcements/{id}:modifyAssignees",
+ "id": "classroom.courses.announcements.modifyAssignees",
+ "path": "v1/courses/{courseId}/announcements/{id}: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."
+ },
+ "patch": {
+ "request": {
+ "$ref": "Announcement"
+ },
+ "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",
+ "httpMethod": "PATCH",
+ "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"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements"
+ ],
+ "flatPath": "v1/courses/{courseId}/announcements/{id}",
+ "id": "classroom.courses.announcements.patch",
+ "path": "v1/courses/{courseId}/announcements/{id}"
+ },
+ "get": {
+ "flatPath": "v1/courses/{courseId}/announcements/{id}",
+ "path": "v1/courses/{courseId}/announcements/{id}",
+ "id": "classroom.courses.announcements.get",
+ "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.",
+ "response": {
+ "$ref": "Announcement"
+ },
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements",
+ "https://www.googleapis.com/auth/classroom.announcements.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 announcement.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "courseId",
+ "id"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements"
+ ],
+ "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 to delete.\nThis identifier is a Classroom-assigned identifier.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/announcements/{id}",
+ "path": "v1/courses/{courseId}/announcements/{id}",
+ "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": {
+ "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.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListAnnouncementsResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "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"
+ },
+ "courseId": {
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
+ "required": true,
+ "type": "string"
+ },
+ "announcementStates": {
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "ANNOUNCEMENT_STATE_UNSPECIFIED",
+ "PUBLISHED",
+ "DRAFT",
+ "DELETED"
+ ],
+ "description": "Restriction on the `state` of announcements returned.\nIf this argument is left unspecified, the default value is `PUBLISHED`."
+ },
+ "orderBy": {
+ "type": "string",
+ "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`"
+ },
+ "pageToken": {
+ "type": "string",
+ "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."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements",
+ "https://www.googleapis.com/auth/classroom.announcements.readonly"
+ ],
+ "flatPath": "v1/courses/{courseId}/announcements",
+ "id": "classroom.courses.announcements.list",
+ "path": "v1/courses/{courseId}/announcements"
+ },
+ "create": {
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.announcements"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/announcements",
+ "path": "v1/courses/{courseId}/announcements",
+ "id": "classroom.courses.announcements.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",
+ "request": {
+ "$ref": "Announcement"
+ },
+ "response": {
+ "$ref": "Announcement"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "httpMethod": "POST"
+ }
+ }
+ },
+ "students": {
+ "methods": {
+ "delete": {
+ "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",
+ "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,
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.rosters"
+ ]
+ },
+ "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"
+ },
+ "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": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/students/{userId}",
+ "path": "v1/courses/{courseId}/students/{userId}",
+ "id": "classroom.courses.students.get"
+ },
+ "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.",
+ "response": {
+ "$ref": "ListStudentsResponse"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "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": {
+ "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": {
+ "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": {
+ "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}/students",
+ "path": "v1/courses/{courseId}/students",
+ "id": "classroom.courses.students.list"
+ },
+ "create": {
+ "response": {
+ "$ref": "Student"
+ },
+ "parameterOrder": [
+ "courseId"
+ ],
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/courses/{courseId}/students",
+ "path": "v1/courses/{courseId}/students",
+ "id": "classroom.courses.students.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"
+ }
+ }
+ }
}
}
},
"userProfiles": {
"methods": {
"get": {
+ "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "userId"
- ],
"response": {
"$ref": "UserProfile"
},
+ "parameterOrder": [
+ "userId"
+ ],
+ "httpMethod": "GET",
"parameters": {
"userId": {
+ "location": "path",
"description": "Identifier of the profile 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"
+ "type": "string"
}
},
"scopes": [
@@ -1646,10 +1642,7 @@
"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}",
- "id": "classroom.userProfiles.get",
- "path": "v1/userProfiles/{userId}"
+ ]
}
},
"resources": {
@@ -1664,29 +1657,11 @@
"studentId"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students",
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
+ ],
"parameters": {
- "invitedEmailAddress": {
- "type": "string",
- "location": "query",
- "description": "If specified, only results with the specified `invited_email_address`\nwill be returned."
- },
- "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"
- ]
- },
- "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"
- },
"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.",
@@ -1694,32 +1669,58 @@
"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"
+ },
+ "invitedEmailAddress": {
"type": "string",
"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."
+ "description": "If specified, only results with the specified `invited_email_address`\nwill be returned."
+ },
+ "states": {
+ "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": {
+ "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": [
- "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": {
+ "response": {
+ "$ref": "GuardianInvitation"
+ },
+ "parameterOrder": [
+ "studentId",
+ "invitationId"
+ ],
+ "httpMethod": "GET",
"parameters": {
- "invitationId": {
- "location": "path",
- "description": "The `id` field of the `GuardianInvitation` being requested.",
- "required": true,
- "type": "string"
- },
"studentId": {
"location": "path",
"description": "The ID of the student whose guardian invitation is being requested.",
"required": true,
"type": "string"
+ },
+ "invitationId": {
+ "description": "The `id` field of the `GuardianInvitation` being requested.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -1729,15 +1730,7 @@
"flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
"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.",
- "response": {
- "$ref": "GuardianInvitation"
- },
- "parameterOrder": [
- "studentId",
- "invitationId"
- ],
- "httpMethod": "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": {
"response": {
@@ -1750,22 +1743,22 @@
"httpMethod": "PATCH",
"parameters": {
"invitationId": {
+ "location": "path",
"description": "The `id` field of the `GuardianInvitation` to be modified.",
"required": true,
+ "type": "string"
+ },
+ "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* `state`\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"
+ },
+ "studentId": {
+ "description": "The ID of the student whose guardian invitation is to be modified.",
+ "required": true,
"type": "string",
"location": "path"
- },
- "updateMask": {
- "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* `state`\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",
- "location": "query"
- },
- "studentId": {
- "location": "path",
- "description": "The ID of the student whose guardian invitation is to be modified.",
- "required": true,
- "type": "string"
}
},
"scopes": [
@@ -1780,17 +1773,19 @@
"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."
},
"create": {
+ "id": "classroom.userProfiles.guardianInvitations.create",
+ "path": "v1/userProfiles/{studentId}/guardianInvitations",
"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": {
"description": "ID of the student (in standard format)",
@@ -1802,66 +1797,22 @@
"scopes": [
"https://www.googleapis.com/auth/classroom.guardianlinks.students"
],
- "flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
- "path": "v1/userProfiles/{studentId}/guardianInvitations",
- "id": "classroom.userProfiles.guardianInvitations.create"
+ "flatPath": "v1/userProfiles/{studentId}/guardianInvitations"
}
}
},
"guardians": {
"methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "studentId",
- "guardianId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "guardianId": {
- "description": "The `id` field from a `Guardian`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "studentId": {
- "location": "path",
- "description": "The student whose guardian is to be deleted. 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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/classroom.guardianlinks.students"
- ],
- "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
- "id": "classroom.userProfiles.guardians.delete",
- "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
- "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`."
- },
"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.",
"httpMethod": "GET",
- "parameterOrder": [
- "studentId"
- ],
"response": {
"$ref": "ListGuardiansResponse"
},
+ "parameterOrder": [
+ "studentId"
+ ],
"parameters": {
- "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"
- },
- "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"
- },
"studentId": {
"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,
@@ -1872,6 +1823,17 @@
"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"
+ },
+ "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"
+ },
+ "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"
}
},
"scopes": [
@@ -1884,10 +1846,6 @@
"path": "v1/userProfiles/{studentId}/guardians"
},
"get": {
- "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
- "id": "classroom.userProfiles.guardians.get",
- "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
- "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",
"parameterOrder": [
"studentId",
@@ -1896,25 +1854,60 @@
"response": {
"$ref": "Guardian"
},
- "parameters": {
- "studentId": {
- "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",
- "required": true,
- "type": "string"
- },
- "guardianId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The `id` field from a `Guardian`."
- }
- },
"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": {
+ "guardianId": {
+ "location": "path",
+ "description": "The `id` field from a `Guardian`.",
+ "required": true,
+ "type": "string"
+ },
+ "studentId": {
+ "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",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "id": "classroom.userProfiles.guardians.get",
+ "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
+ "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`."
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "studentId",
+ "guardianId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/classroom.guardianlinks.students"
+ ],
+ "parameters": {
+ "guardianId": {
+ "location": "path",
+ "description": "The `id` field from a `Guardian`.",
+ "required": true,
+ "type": "string"
+ },
+ "studentId": {
+ "description": "The student whose guardian is to be deleted. 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",
+ "location": "path"
+ }
+ },
+ "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`."
}
}
}
@@ -1923,24 +1916,24 @@
"registrations": {
"methods": {
"create": {
+ "flatPath": "v1/registrations",
+ "id": "classroom.registrations.create",
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "Registration"
},
- "parameterOrder": [],
- "httpMethod": "POST",
+ "parameters": {},
"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": {},
- "flatPath": "v1/registrations",
- "path": "v1/registrations",
- "id": "classroom.registrations.create",
- "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.",
- "request": {
- "$ref": "Registration"
- }
+ ]
},
"delete": {
"description": "Deletes a `Registration`, causing Classroom to stop sending notifications\nfor that `Registration`.",
@@ -1951,6 +1944,11 @@
"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": {
"location": "path",
@@ -1959,11 +1957,6 @@
"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"
@@ -1972,34 +1965,80 @@
}
},
"parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "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"
},
- "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",
+ "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"
+ },
+ "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"
+ },
+ "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",
@@ -2009,791 +2048,13 @@
"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"
- ]
- },
- "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": {
- "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"
- },
- "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"
+ "description": "V1 error format."
}
},
"schemas": {
- "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": {
- "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": {
- "type": "string",
- "description": "Enrollment code to use when joining this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only."
- },
- "courseMaterialSets": {
- "description": "Sets of materials that appear on the \"about\" page of this course.\n\nRead-only.",
- "type": "array",
- "items": {
- "$ref": "CourseMaterialSet"
- }
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "alternateLink": {
- "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.",
- "type": "string"
- },
- "guardiansEnabled": {
- "type": "boolean",
- "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only."
- },
- "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": {
- "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."
- ],
- "enum": [
- "COURSE_STATE_UNSPECIFIED",
- "ACTIVE",
- "ARCHIVED",
- "PROVISIONED",
- "DECLINED",
- "SUSPENDED"
- ],
- "description": "State of the course.\nIf unspecified, the default state is `PROVISIONED`."
- },
- "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"
- }
- },
- "id": "Course"
- },
- "DriveFile": {
- "id": "DriveFile",
- "description": "Representation of a Google Drive file.",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "Drive API resource ID."
- },
- "title": {
- "type": "string",
- "description": "Title of the Drive item.\n\nRead-only."
- },
- "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"
- }
- }
- },
- "ReturnStudentSubmissionRequest": {
- "description": "Request to return a student submission.",
- "type": "object",
- "properties": {},
- "id": "ReturnStudentSubmissionRequest"
- },
- "ReclaimStudentSubmissionRequest": {
- "description": "Request to reclaim a student submission.",
- "type": "object",
- "properties": {},
- "id": "ReclaimStudentSubmissionRequest"
- },
- "CourseRosterChangesInfo": {
- "id": "CourseRosterChangesInfo",
- "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.",
- "type": "object",
- "properties": {
- "courseId": {
- "description": "The `course_id` of the course to subscribe to roster changes for.",
- "type": "string"
- }
- }
- },
- "Topic": {
- "description": "Topic created by a teacher for the course",
- "type": "object",
- "properties": {
- "updateTime": {
- "description": "The time the topic was last updated by the system.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "The name of the topic, generated by the user.\nLeading and trailing whitespaces, if any, will be trimmed. Also, multiple\nconsecutive whitespaces will be collapsed into one inside the name.\nTopic names are case sensitive, and must be no longer than 100 characters.",
- "type": "string"
- },
- "topicId": {
- "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": {
- "type": "object",
- "properties": {
- "workType": {
- "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": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed."
- },
- "assignment": {
- "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only.",
- "$ref": "Assignment"
- },
- "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."
- },
- "scheduledTime": {
- "description": "Optional timestamp when this course work is scheduled to be published.",
- "format": "google-datetime",
- "type": "string"
- },
- "description": {
- "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"
- },
- "creationTime": {
- "description": "Timestamp when this course work was created.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "creatorUserId": {
- "description": "Identifier for the user that created the coursework.\n\nRead-only.",
- "type": "string"
- },
- "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.",
- "$ref": "IndividualStudentsOptions"
- },
- "dueDate": {
- "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified.",
- "$ref": "Date"
- },
- "state": {
- "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",
- "type": "string",
- "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.",
- "Status for work that was published but is now deleted.\nWork in this state is visible only to course teachers and domain\nadministrators.\nWork in this state is deleted after some time."
- ],
- "enum": [
- "COURSE_WORK_STATE_UNSPECIFIED",
- "PUBLISHED",
- "DRAFT",
- "DELETED"
- ]
- },
- "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`.",
- "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": {
- "$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": {
- "type": "boolean",
- "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."
- },
- "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",
- "ALL_STUDENTS",
- "INDIVIDUAL_STUDENTS"
- ],
- "description": "Assignee mode of the coursework.\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."
- ]
- },
- "maxPoints": {
- "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",
- "type": "number"
- }
- },
- "id": "CourseWork",
- "description": "Course work created by a teacher for students of the course."
- },
- "Guardian": {
- "properties": {
- "guardianProfile": {
- "$ref": "UserProfile",
- "description": "User profile for the guardian."
- },
- "studentId": {
- "description": "Identifier for the student to whom the guardian relationship applies.",
- "type": "string"
- },
- "guardianId": {
- "description": "Identifier for the guardian.",
- "type": "string"
- },
- "invitedEmailAddress": {
- "description": "The email address to which the initial guardian invitation was sent.\nThis field is only visible to domain administrators.",
- "type": "string"
- }
- },
- "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": {
- "type": "string",
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available."
- }
- },
- "id": "ListStudentsResponse"
- },
- "UserProfile": {
- "description": "Global information for a user.",
- "type": "object",
- "properties": {
- "emailAddress": {
- "type": "string",
- "description": "Email address of the user.\n\nRead-only."
- },
- "photoUrl": {
- "description": "URL of user's profile photo.\n\nRead-only.",
- "type": "string"
- },
- "permissions": {
- "description": "Global permissions of the user.\n\nRead-only.",
- "type": "array",
- "items": {
- "$ref": "GlobalPermission"
- }
- },
- "name": {
- "description": "Name of the user.\n\nRead-only.",
- "$ref": "Name"
- },
- "id": {
- "description": "Identifier of the user.\n\nRead-only.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "UserProfile"
- },
- "Announcement": {
- "description": "Announcement created by a teacher for students of the course",
- "type": "object",
- "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",
- "type": "string"
- },
- "creationTime": {
- "description": "Timestamp when this announcement was created.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "creatorUserId": {
- "type": "string",
- "description": "Identifier for the user that created the announcement.\n\nRead-only."
- },
- "individualStudentsOptions": {
- "$ref": "IndividualStudentsOptions",
- "description": "Identifiers of students with access to the announcement.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this\nfield will be able to see the announcement."
- },
- "state": {
- "enumDescriptions": [
- "No state specified. This is never returned.",
- "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"
- ],
- "description": "Status of this announcement.\nIf unspecified, the default state is `DRAFT`.",
- "type": "string"
- },
- "text": {
- "description": "Description of this announcement.\nThe text must be a valid UTF-8 string containing no more\nthan 30,000 characters.",
- "type": "string"
- },
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
- },
- "id": {
- "description": "Classroom-assigned identifier of this announcement, unique per course.\n\nRead-only.",
- "type": "string"
- }
- },
- "id": "Announcement"
- },
- "ModifyIndividualStudentsOptions": {
- "description": "Contains fields to add or remove students from a course work or announcement\nwhere the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.",
- "type": "object",
- "properties": {
- "addStudentIds": {
- "description": "Ids of students to be added as having access to this\ncoursework/announcement.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "removeStudentIds": {
- "description": "Ids of students to be removed from having access to this\ncoursework/announcement.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ModifyIndividualStudentsOptions"
- },
- "DriveFolder": {
- "description": "Representation of a Google Drive folder.",
- "type": "object",
- "properties": {
- "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": {
- "description": "Drive API resource ID.",
- "type": "string"
- }
- },
- "id": "DriveFolder"
- },
- "SubmissionHistory": {
- "id": "SubmissionHistory",
- "description": "The history of the submission. This currently includes state and grade\nhistories.",
- "type": "object",
- "properties": {
- "stateHistory": {
- "$ref": "StateHistory",
- "description": "The state history information of the submission, if present."
- },
- "gradeHistory": {
- "$ref": "GradeHistory",
- "description": "The grade history information of the submission, if present."
- }
- }
- },
- "ShortAnswerSubmission": {
- "type": "object",
- "properties": {
- "answer": {
- "description": "Student response to a short-answer question.",
- "type": "string"
- }
- },
- "id": "ShortAnswerSubmission",
- "description": "Student work for a short answer question."
- },
- "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": {
- "type": "object",
- "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": {
- "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": "Type of course work this submission is for.\n\nRead-only.",
- "type": "string"
- },
- "creationTime": {
- "type": "string",
- "description": "Creation time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
- "format": "google-datetime"
- },
- "state": {
- "enum": [
- "SUBMISSION_STATE_UNSPECIFIED",
- "NEW",
- "CREATED",
- "TURNED_IN",
- "RETURNED",
- "RECLAIMED_BY_STUDENT"
- ],
- "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.",
- "Has been created.",
- "Has been turned in to the teacher.",
- "Has been returned to the student.",
- "Student chose to \"unsubmit\" the assignment."
- ]
- },
- "userId": {
- "description": "Identifier for the student that owns this submission.\n\nRead-only.",
- "type": "string"
- },
- "courseWorkId": {
- "description": "Identifier for the course work this corresponds to.\n\nRead-only.",
- "type": "string"
- },
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
- "type": "string"
- },
- "id": {
- "description": "Classroom-assigned Identifier for the student submission.\nThis is unique among submissions for the relevant course work.\n\nRead-only.",
- "type": "string"
- },
- "submissionHistory": {
- "description": "The history of the submission (includes state and grade histories).\n\nRead-only.",
- "type": "array",
- "items": {
- "$ref": "SubmissionHistory"
- }
- },
- "assignedGrade": {
- "description": "Optional 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 may be modified only by course teachers.",
- "format": "double",
- "type": "number"
- },
- "multipleChoiceSubmission": {
- "$ref": "MultipleChoiceSubmission",
- "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION."
- },
- "assignmentSubmission": {
- "$ref": "AssignmentSubmission",
- "description": "Submission content when course_work_type is ASSIGNMENT.\n\nStudents can modify this content using\ngoogle.classroom.Work.ModifyAttachments."
- },
- "associatedWithDeveloper": {
- "description": "Whether this student submission is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
- "type": "boolean"
- },
- "shortAnswerSubmission": {
- "$ref": "ShortAnswerSubmission",
- "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."
- },
- "updateTime": {
- "description": "Last update time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "alternateLink": {
- "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only.",
- "type": "string"
- }
- },
- "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."
- },
- "ModifyAttachmentsRequest": {
- "id": "ModifyAttachmentsRequest",
- "description": "Request to modify the attachments of a student submission.",
- "type": "object",
- "properties": {
- "addAttachments": {
- "description": "Attachments to add.\nA student submission may not have more than 20 attachments.\n\nForm attachments are not supported.",
- "type": "array",
- "items": {
- "$ref": "Attachment"
- }
- }
- }
- },
- "YouTubeVideo": {
- "description": "YouTube video item.",
- "type": "object",
- "properties": {
- "id": {
- "description": "YouTube API resource ID.",
- "type": "string"
- },
- "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"
- },
- "thumbnailUrl": {
- "description": "URL of a thumbnail image of the YouTube video.\n\nRead-only.",
- "type": "string"
- }
- },
- "id": "YouTubeVideo"
- },
- "ListInvitationsResponse": {
- "id": "ListInvitationsResponse",
- "description": "Response when listing invitations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available."
- },
- "invitations": {
- "description": "Invitations that match the list request.",
- "type": "array",
- "items": {
- "$ref": "Invitation"
- }
- }
- }
- },
"CloudPubsubTopic": {
+ "description": "A reference to a Cloud Pub/Sub topic.\n\nTo register for notifications, the owner of the topic must grant\n`classroom-notifications@system.gserviceaccount.com` the\n `projects.topics.publish` permission.",
"type": "object",
"properties": {
"topicName": {
@@ -2801,19 +2062,21 @@
"type": "string"
}
},
- "id": "CloudPubsubTopic",
- "description": "A reference to a Cloud Pub/Sub topic.\n\nTo register for notifications, the owner of the topic must grant\n`classroom-notifications@system.gserviceaccount.com` the\n `projects.topics.publish` permission."
+ "id": "CloudPubsubTopic"
},
"GuardianInvitation": {
"description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address.",
"type": "object",
"properties": {
+ "invitationId": {
+ "type": "string",
+ "description": "Unique identifier for this invitation.\n\nRead-only."
+ },
"studentId": {
"type": "string",
"description": "ID of the student (in standard format)"
},
"state": {
- "type": "string",
"enumDescriptions": [
"Should never be returned.",
"The invitation is active and awaiting a response.",
@@ -2824,7 +2087,8 @@
"PENDING",
"COMPLETE"
],
- "description": "The state that this invitation is in."
+ "description": "The state that this invitation is in.",
+ "type": "string"
},
"invitedEmailAddress": {
"description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.",
@@ -2834,10 +2098,6 @@
"description": "The time that this invitation was created.\n\nRead-only.",
"format": "google-datetime",
"type": "string"
- },
- "invitationId": {
- "description": "Unique identifier for this invitation.\n\nRead-only.",
- "type": "string"
}
},
"id": "GuardianInvitation"
@@ -2897,8 +2157,6 @@
"id": "CourseMaterialSet"
},
"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.",
@@ -2912,45 +2170,47 @@
}
}
},
- "id": "ListTeachersResponse"
+ "id": "ListTeachersResponse",
+ "description": "Response when listing teachers.",
+ "type": "object"
},
"Link": {
+ "description": "URL item.",
+ "type": "object",
"properties": {
+ "title": {
+ "type": "string",
+ "description": "Title of the target of the URL.\n\nRead-only."
+ },
"thumbnailUrl": {
"description": "URL of a thumbnail image of the target URL.\n\nRead-only.",
"type": "string"
},
"url": {
- "type": "string",
- "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters."
- },
- "title": {
- "description": "Title of the target of the URL.\n\nRead-only.",
+ "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",
"type": "string"
}
},
- "id": "Link",
- "description": "URL item.",
- "type": "object"
+ "id": "Link"
},
"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": {
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
+ "format": "int32",
+ "type": "integer"
+ },
"year": {
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"format": "int32",
"type": "integer"
},
"day": {
+ "type": "integer",
"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"
+ "format": "int32"
}
},
"id": "Date"
@@ -2960,10 +2220,6 @@
"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"
@@ -2971,27 +2227,31 @@
"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"
}
}
},
"Assignment": {
- "properties": {
- "studentWorkFolder": {
- "$ref": "DriveFolder",
- "description": "Drive folder where attachments from student submissions are placed.\nThis is only populated for course teachers and administrators."
- }
- },
"id": "Assignment",
"description": "Additional details for assignments.",
- "type": "object"
+ "type": "object",
+ "properties": {
+ "studentWorkFolder": {
+ "description": "Drive folder where attachments from student submissions are placed.\nThis is only populated for course teachers and administrators.",
+ "$ref": "DriveFolder"
+ }
+ }
},
"SharedDriveFile": {
"description": "Drive file that is used as material for course work.",
"type": "object",
"properties": {
"driveFile": {
- "description": "Drive file details.",
- "$ref": "DriveFile"
+ "$ref": "DriveFile",
+ "description": "Drive file details."
},
"shareMode": {
"enumDescriptions": [
@@ -3013,27 +2273,27 @@
"id": "SharedDriveFile"
},
"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": {},
- "id": "Empty"
+ "properties": {}
},
"ModifyAnnouncementAssigneesRequest": {
"description": "Request to modify assignee mode and options of an announcement.",
"type": "object",
"properties": {
"assigneeMode": {
+ "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",
"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": {
@@ -3048,15 +2308,15 @@
"type": "object",
"properties": {
"permission": {
+ "enum": [
+ "PERMISSION_UNSPECIFIED",
+ "CREATE_COURSE"
+ ],
"description": "Permission value.",
"type": "string",
"enumDescriptions": [
"No permission is specified. This is not returned and is not a\nvalid value.",
"User is permitted to create a course."
- ],
- "enum": [
- "PERMISSION_UNSPECIFIED",
- "CREATE_COURSE"
]
}
},
@@ -3067,12 +2327,12 @@
"type": "object",
"properties": {
"courseId": {
- "type": "string",
- "description": "Identifier of the course.\n\nRead-only."
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
},
"profile": {
- "description": "Global user information for the teacher.\n\nRead-only.",
- "$ref": "UserProfile"
+ "$ref": "UserProfile",
+ "description": "Global user information for the teacher.\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",
@@ -3095,25 +2355,25 @@
"type": "string"
},
"gradeChangeType": {
- "enum": [
- "UNKNOWN_GRADE_CHANGE_TYPE",
- "DRAFT_GRADE_POINTS_EARNED_CHANGE",
- "ASSIGNED_GRADE_POINTS_EARNED_CHANGE",
- "MAX_POINTS_CHANGE"
- ],
- "description": "The type of grade change at this time in the submission grade history.",
"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."
- ]
+ ],
+ "enum": [
+ "UNKNOWN_GRADE_CHANGE_TYPE",
+ "DRAFT_GRADE_POINTS_EARNED_CHANGE",
+ "ASSIGNED_GRADE_POINTS_EARNED_CHANGE",
+ "MAX_POINTS_CHANGE"
+ ],
+ "description": "The type of grade change at this time in the submission grade history."
},
"maxPoints": {
+ "type": "number",
"description": "The denominator of the grade at this time in the submission grade\nhistory.",
- "format": "double",
- "type": "number"
+ "format": "double"
},
"pointsEarned": {
"description": "The numerator of the grade at this time in the submission grade history.",
@@ -3124,6 +2384,8 @@
"id": "GradeHistory"
},
"AssignmentSubmission": {
+ "description": "Student work for an assignment.",
+ "type": "object",
"properties": {
"attachments": {
"description": "Attachments added by the student.\nDrive files that correspond to materials with a share mode of\nSTUDENT_COPY may not exist yet if the student has not accessed the\nassignment in Classroom.\n\nSome attachment metadata is only populated if the requesting user has\npermission to access it. Identifier and alternate_link fields are always\navailable, but others (e.g. title) may not be.",
@@ -3133,13 +2395,16 @@
}
}
},
- "id": "AssignmentSubmission",
- "description": "Student work for an assignment.",
- "type": "object"
+ "id": "AssignmentSubmission"
},
"Material": {
+ "description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported.",
"type": "object",
"properties": {
+ "form": {
+ "$ref": "Form",
+ "description": "Google Forms material."
+ },
"link": {
"description": "Link material. On creation, will be upgraded to a more appropriate type\nif possible, and this will be reflected in the response.",
"$ref": "Link"
@@ -3149,19 +2414,13 @@
"description": "YouTube video material."
},
"driveFile": {
- "$ref": "SharedDriveFile",
- "description": "Google Drive file material."
- },
- "form": {
- "description": "Google Forms material.",
- "$ref": "Form"
+ "description": "Google Drive file material.",
+ "$ref": "SharedDriveFile"
}
},
- "id": "Material",
- "description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported."
+ "id": "Material"
},
"Feed": {
- "id": "Feed",
"description": "A class of notifications that an application can register to receive.\nFor example: \"all roster changes for a domain\".",
"type": "object",
"properties": {
@@ -3170,8 +2429,6 @@
"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": {
- "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.",
@@ -3181,14 +2438,20 @@
"FEED_TYPE_UNSPECIFIED",
"DOMAIN_ROSTER_CHANGES",
"COURSE_ROSTER_CHANGES"
- ]
+ ],
+ "description": "The type of feed.",
+ "type": "string"
}
- }
+ },
+ "id": "Feed"
},
"Student": {
- "description": "Student in a course.",
"type": "object",
"properties": {
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
+ },
"profile": {
"$ref": "UserProfile",
"description": "Global user information for the student.\n\nRead-only."
@@ -3198,40 +2461,17 @@
"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": {
- "type": "string",
- "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"
- },
- "courseId": {
- "description": "Identifier of the course.\n\nRead-only.",
+ "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"
}
},
- "id": "Student"
+ "id": "Student",
+ "description": "Student in a course."
},
"Invitation": {
"description": "An invitation to join a course.",
"type": "object",
"properties": {
- "role": {
- "enum": [
- "COURSE_ROLE_UNSPECIFIED",
- "STUDENT",
- "TEACHER",
- "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."
- ]
- },
- "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": {
"description": "Identifier of the course to invite the user to.",
"type": "string"
@@ -3239,58 +2479,80 @@
"id": {
"description": "Identifier assigned by Classroom.\n\nRead-only.",
"type": "string"
+ },
+ "role": {
+ "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."
+ ],
+ "enum": [
+ "COURSE_ROLE_UNSPECIFIED",
+ "STUDENT",
+ "TEACHER",
+ "OWNER"
+ ]
+ },
+ "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"
}
},
"id": "Invitation"
},
"TurnInStudentSubmissionRequest": {
+ "id": "TurnInStudentSubmissionRequest",
"description": "Request to turn in a student submission.",
"type": "object",
- "properties": {},
- "id": "TurnInStudentSubmissionRequest"
+ "properties": {}
},
"ListCourseWorkResponse": {
- "id": "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": {
- "description": "Google Drive file attachment.",
- "$ref": "DriveFile"
- },
- "youTubeVideo": {
- "description": "Youtube video attachment.",
- "$ref": "YouTubeVideo"
- },
"form": {
- "description": "Google Forms attachment.",
- "$ref": "Form"
+ "$ref": "Form",
+ "description": "Google Forms attachment."
},
"link": {
"$ref": "Link",
"description": "Link attachment."
+ },
+ "driveFile": {
+ "$ref": "DriveFile",
+ "description": "Google Drive file attachment."
+ },
+ "youTubeVideo": {
+ "$ref": "YouTubeVideo",
+ "description": "Youtube video attachment."
}
},
- "id": "Attachment",
- "description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported."
+ "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.",
@@ -3304,11 +2566,11 @@
}
}
},
- "id": "ListTopicResponse",
- "description": "Response when listing topics.",
- "type": "object"
+ "id": "ListTopicResponse"
},
"ListAnnouncementsResponse": {
+ "id": "ListAnnouncementsResponse",
+ "description": "Response when listing course work.",
"type": "object",
"properties": {
"announcements": {
@@ -3322,14 +2584,17 @@
"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."
+ }
},
"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": {
+ "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",
@@ -3344,11 +2609,6 @@
"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"
}
},
"id": "TimeOfDay"
@@ -3357,16 +2617,16 @@
"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"
}
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
}
},
"id": "ListCoursesResponse"
@@ -3376,8 +2636,8 @@
"type": "object",
"properties": {
"title": {
- "description": "Title of the Form.\n\nRead-only.",
- "type": "string"
+ "type": "string",
+ "description": "Title of the Form.\n\nRead-only."
},
"thumbnailUrl": {
"description": "URL of a thumbnail image of the Form.\n\nRead-only.",
@@ -3395,73 +2655,73 @@
"id": "Form"
},
"ModifyCourseWorkAssigneesRequest": {
- "id": "ModifyCourseWorkAssigneesRequest",
"description": "Request to modify assignee mode and options of a coursework.",
"type": "object",
"properties": {
"assigneeMode": {
+ "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",
"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": {
- "$ref": "ModifyIndividualStudentsOptions",
- "description": "Set which students are assigned or not assigned to the coursework.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`."
+ "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": {
- "nextPageToken": {
- "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
- "type": "string"
- },
"guardians": {
"description": "Guardians on this page of results that met the criteria specified in\nthe request.",
"type": "array",
"items": {
"$ref": "Guardian"
}
- }
- },
- "id": "ListGuardiansResponse",
- "description": "Response when listing guardians.",
- "type": "object"
- },
- "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.",
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
"type": "string"
}
},
- "id": "CourseAlias",
+ "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"
+ "type": "object",
+ "properties": {
+ "alias": {
+ "type": "string",
+ "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."
+ }
+ },
+ "id": "CourseAlias"
},
"ListCourseAliasesResponse": {
"description": "Response when listing course aliases.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ },
"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"
@@ -3485,7 +2745,6 @@
"id": "ListGuardianInvitationsResponse"
},
"IndividualStudentsOptions": {
- "id": "IndividualStudentsOptions",
"description": "Assignee details about a coursework/announcement.\nThis field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.",
"type": "object",
"properties": {
@@ -3496,20 +2755,11 @@
"type": "string"
}
}
- }
- },
- "MultipleChoiceSubmission": {
- "properties": {
- "answer": {
- "description": "Student's select choice.",
- "type": "string"
- }
},
- "id": "MultipleChoiceSubmission",
- "description": "Student work for a multiple-choice question.",
- "type": "object"
+ "id": "IndividualStudentsOptions"
},
"Registration": {
+ "id": "Registration",
"description": "An instruction to Classroom to send notifications from the `feed` to the\nprovided `destination`.",
"type": "object",
"properties": {
@@ -3530,31 +2780,781 @@
"description": "A server-generated unique identifier for this `Registration`.\n\nRead-only.",
"type": "string"
}
- },
- "id": "Registration"
+ }
+ },
+ "MultipleChoiceSubmission": {
+ "id": "MultipleChoiceSubmission",
+ "description": "Student work for a multiple-choice question.",
+ "type": "object",
+ "properties": {
+ "answer": {
+ "description": "Student's select choice.",
+ "type": "string"
+ }
+ }
},
"CourseMaterial": {
- "id": "CourseMaterial",
"description": "A material attached to a course as part of a material set.",
"type": "object",
"properties": {
"driveFile": {
- "description": "Google Drive file attachment.",
- "$ref": "DriveFile"
+ "$ref": "DriveFile",
+ "description": "Google Drive file attachment."
},
"youTubeVideo": {
"$ref": "YouTubeVideo",
"description": "Youtube video attachment."
},
"form": {
- "$ref": "Form",
- "description": "Google Forms attachment."
+ "description": "Google Forms attachment.",
+ "$ref": "Form"
},
"link": {
- "description": "Link atatchment.",
- "$ref": "Link"
+ "$ref": "Link",
+ "description": "Link atatchment."
}
- }
+ },
+ "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": {
+ "properties": {
+ "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"
+ }
+ },
+ "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"
+ },
+ "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."
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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": "Course",
+ "description": "A Course in Classroom.",
+ "type": "object"
+ },
+ "DriveFile": {
+ "description": "Representation of a Google Drive file.",
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "Title of the Drive item.\n\nRead-only.",
+ "type": "string"
+ },
+ "alternateLink": {
+ "description": "URL that can be used to access the Drive item.\n\nRead-only.",
+ "type": "string"
+ },
+ "thumbnailUrl": {
+ "type": "string",
+ "description": "URL of a thumbnail image of the Drive item.\n\nRead-only."
+ },
+ "id": {
+ "description": "Drive API resource ID.",
+ "type": "string"
+ }
+ },
+ "id": "DriveFile"
+ },
+ "ReturnStudentSubmissionRequest": {
+ "description": "Request to return a student submission.",
+ "type": "object",
+ "properties": {},
+ "id": "ReturnStudentSubmissionRequest"
+ },
+ "ReclaimStudentSubmissionRequest": {
+ "description": "Request to reclaim a student submission.",
+ "type": "object",
+ "properties": {},
+ "id": "ReclaimStudentSubmissionRequest"
+ },
+ "CourseRosterChangesInfo": {
+ "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.",
+ "type": "object",
+ "properties": {
+ "courseId": {
+ "description": "The `course_id` of the course to subscribe to roster changes for.",
+ "type": "string"
+ }
+ },
+ "id": "CourseRosterChangesInfo"
+ },
+ "Topic": {
+ "properties": {
+ "courseId": {
+ "description": "Identifier of the course.\n\nRead-only.",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "The time the topic was last updated by the system.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the topic, generated by the user.\nLeading and trailing whitespaces, if any, will be trimmed. Also, multiple\nconsecutive whitespaces will be collapsed into one inside the name.\nTopic names are case sensitive, and must be no longer than 100 characters.",
+ "type": "string"
+ },
+ "topicId": {
+ "description": "Unique identifier for the topic.\n\nRead-only.",
+ "type": "string"
+ }
+ },
+ "id": "Topic",
+ "description": "Topic created by a teacher for the course",
+ "type": "object"
+ },
+ "CourseWork": {
+ "description": "Course work created by a teacher for students of the course.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "type": "string",
+ "description": "Timestamp of the most recent change to this course work.\n\nRead-only.",
+ "format": "google-datetime"
+ },
+ "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": {
+ "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 coursework.\nIf unspecified, the default value is `ALL_STUDENTS`.",
+ "type": "string"
+ },
+ "maxPoints": {
+ "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",
+ "type": "number"
+ },
+ "workType": {
+ "enum": [
+ "COURSE_WORK_TYPE_UNSPECIFIED",
+ "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",
+ "enumDescriptions": [
+ "No work type specified. This is never returned.",
+ "An assignment.",
+ "A short answer question.",
+ "A multiple-choice question."
+ ]
+ },
+ "assignment": {
+ "$ref": "Assignment",
+ "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only."
+ },
+ "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."
+ },
+ "description": {
+ "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.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "creationTime": {
+ "description": "Timestamp when this course work was created.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "creatorUserId": {
+ "description": "Identifier for the user that created the coursework.\n\nRead-only.",
+ "type": "string"
+ },
+ "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.",
+ "$ref": "IndividualStudentsOptions"
+ },
+ "dueDate": {
+ "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified.",
+ "$ref": "Date"
+ },
+ "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`.",
+ "type": "string"
+ },
+ "state": {
+ "enum": [
+ "COURSE_WORK_STATE_UNSPECIFIED",
+ "PUBLISHED",
+ "DRAFT",
+ "DELETED"
+ ],
+ "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",
+ "type": "string",
+ "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.",
+ "Status for work that was published but is now deleted.\nWork in this state is visible only to course teachers and domain\nadministrators.\nWork in this state is deleted after some time."
+ ]
+ },
+ "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"
+ }
+ },
+ "id": "CourseWork"
+ },
+ "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.",
+ "type": "string"
+ },
+ "guardianId": {
+ "description": "Identifier for the guardian.",
+ "type": "string"
+ },
+ "invitedEmailAddress": {
+ "description": "The email address to which the initial guardian invitation was sent.\nThis field is only visible to domain administrators.",
+ "type": "string"
+ },
+ "guardianProfile": {
+ "$ref": "UserProfile",
+ "description": "User profile for the guardian."
+ }
+ },
+ "id": "Guardian"
+ },
+ "UserProfile": {
+ "type": "object",
+ "properties": {
+ "emailAddress": {
+ "description": "Email address of the user.\n\nRead-only.",
+ "type": "string"
+ },
+ "photoUrl": {
+ "description": "URL of user's profile photo.\n\nRead-only.",
+ "type": "string"
+ },
+ "permissions": {
+ "description": "Global permissions of the user.\n\nRead-only.",
+ "type": "array",
+ "items": {
+ "$ref": "GlobalPermission"
+ }
+ },
+ "name": {
+ "$ref": "Name",
+ "description": "Name of the user.\n\nRead-only."
+ },
+ "id": {
+ "description": "Identifier of the user.\n\nRead-only.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "UserProfile",
+ "description": "Global information for a user."
+ },
+ "ListStudentsResponse": {
+ "type": "object",
+ "properties": {
+ "students": {
+ "type": "array",
+ "items": {
+ "$ref": "Student"
+ },
+ "description": "Students who match the list request."
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ }
+ },
+ "id": "ListStudentsResponse",
+ "description": "Response when listing students."
+ },
+ "Announcement": {
+ "properties": {
+ "scheduledTime": {
+ "description": "Optional timestamp when this announcement is scheduled to be published.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "creationTime": {
+ "description": "Timestamp when this announcement was created.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "individualStudentsOptions": {
+ "description": "Identifiers of students with access to the announcement.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this\nfield will be able to see the announcement.",
+ "$ref": "IndividualStudentsOptions"
+ },
+ "creatorUserId": {
+ "description": "Identifier for the user that created the announcement.\n\nRead-only.",
+ "type": "string"
+ },
+ "state": {
+ "enumDescriptions": [
+ "No state specified. This is never returned.",
+ "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"
+ ],
+ "description": "Status of this announcement.\nIf unspecified, the default state is `DRAFT`.",
+ "type": "string"
+ },
+ "text": {
+ "description": "Description of this announcement.\nThe text must be a valid UTF-8 string containing no more\nthan 30,000 characters.",
+ "type": "string"
+ },
+ "courseId": {
+ "type": "string",
+ "description": "Identifier of the course.\n\nRead-only."
+ },
+ "id": {
+ "type": "string",
+ "description": "Classroom-assigned identifier of this announcement, unique per course.\n\nRead-only."
+ },
+ "materials": {
+ "description": "Additional materials.\n\nAnnouncements must have no more than 20 material items.",
+ "type": "array",
+ "items": {
+ "$ref": "Material"
+ }
+ },
+ "updateTime": {
+ "type": "string",
+ "description": "Timestamp of the most recent change to this announcement.\n\nRead-only.",
+ "format": "google-datetime"
+ },
+ "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",
+ "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`.",
+ "type": "object",
+ "properties": {
+ "addStudentIds": {
+ "description": "Ids of students to be added as having access to this\ncoursework/announcement.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "removeStudentIds": {
+ "description": "Ids of students to be removed from having access to this\ncoursework/announcement.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ModifyIndividualStudentsOptions"
+ },
+ "DriveFolder": {
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "Drive API resource ID.",
+ "type": "string"
+ }
+ },
+ "id": "DriveFolder",
+ "description": "Representation of a Google Drive folder."
+ },
+ "SubmissionHistory": {
+ "description": "The history of the submission. This currently includes state and grade\nhistories.",
+ "type": "object",
+ "properties": {
+ "stateHistory": {
+ "$ref": "StateHistory",
+ "description": "The state history information of the submission, if present."
+ },
+ "gradeHistory": {
+ "description": "The grade history information of the submission, if present.",
+ "$ref": "GradeHistory"
+ }
+ },
+ "id": "SubmissionHistory"
+ },
+ "ShortAnswerSubmission": {
+ "description": "Student work for a short answer question.",
+ "type": "object",
+ "properties": {
+ "answer": {
+ "description": "Student response to a short-answer question.",
+ "type": "string"
+ }
+ },
+ "id": "ShortAnswerSubmission"
+ },
+ "StudentSubmission": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Classroom-assigned Identifier for the student submission.\nThis is unique among submissions for the relevant course work.\n\nRead-only.",
+ "type": "string"
+ },
+ "submissionHistory": {
+ "description": "The history of the submission (includes state and grade histories).\n\nRead-only.",
+ "type": "array",
+ "items": {
+ "$ref": "SubmissionHistory"
+ }
+ },
+ "assignedGrade": {
+ "description": "Optional 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 may be modified only by course teachers.",
+ "format": "double",
+ "type": "number"
+ },
+ "multipleChoiceSubmission": {
+ "$ref": "MultipleChoiceSubmission",
+ "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION."
+ },
+ "assignmentSubmission": {
+ "$ref": "AssignmentSubmission",
+ "description": "Submission content when course_work_type is ASSIGNMENT.\n\nStudents can modify this content using\ngoogle.classroom.Work.ModifyAttachments."
+ },
+ "associatedWithDeveloper": {
+ "description": "Whether this student submission is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
+ "type": "boolean"
+ },
+ "shortAnswerSubmission": {
+ "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION.",
+ "$ref": "ShortAnswerSubmission"
+ },
+ "updateTime": {
+ "description": "Last update time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "alternateLink": {
+ "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only.",
+ "type": "string"
+ },
+ "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"
+ },
+ "late": {
+ "description": "Whether this submission is late.\n\nRead-only.",
+ "type": "boolean"
+ },
+ "courseWorkType": {
+ "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": "Type of course work this submission is for.\n\nRead-only.",
+ "type": "string"
+ },
+ "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.",
+ "Has been created.",
+ "Has been turned in to the teacher.",
+ "Has been returned to the student.",
+ "Student chose to \"unsubmit\" the assignment."
+ ],
+ "enum": [
+ "SUBMISSION_STATE_UNSPECIFIED",
+ "NEW",
+ "CREATED",
+ "TURNED_IN",
+ "RETURNED",
+ "RECLAIMED_BY_STUDENT"
+ ]
+ },
+ "userId": {
+ "description": "Identifier for the student that owns this submission.\n\nRead-only.",
+ "type": "string"
+ },
+ "courseWorkId": {
+ "description": "Identifier for the course work this corresponds to.\n\nRead-only.",
+ "type": "string"
+ },
+ "courseId": {
+ "type": "string",
+ "description": "Identifier of the course.\n\nRead-only."
+ }
+ },
+ "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."
+ },
+ "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"
+ },
+ "ModifyAttachmentsRequest": {
+ "description": "Request to modify the attachments of a student submission.",
+ "type": "object",
+ "properties": {
+ "addAttachments": {
+ "description": "Attachments to add.\nA student submission may not have more than 20 attachments.\n\nForm attachments are not supported.",
+ "type": "array",
+ "items": {
+ "$ref": "Attachment"
+ }
+ }
+ },
+ "id": "ModifyAttachmentsRequest"
+ },
+ "YouTubeVideo": {
+ "description": "YouTube video item.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "YouTube API resource ID.",
+ "type": "string"
+ },
+ "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"
+ },
+ "thumbnailUrl": {
+ "description": "URL of a thumbnail image of the YouTube video.\n\nRead-only.",
+ "type": "string"
+ }
+ },
+ "id": "YouTubeVideo"
+ },
+ "ListInvitationsResponse": {
+ "description": "Response when listing invitations.",
+ "type": "object",
+ "properties": {
+ "invitations": {
+ "description": "Invitations that match the list request.",
+ "type": "array",
+ "items": {
+ "$ref": "Invitation"
+ }
+ },
+ "nextPageToken": {
+ "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
+ "type": "string"
+ }
+ },
+ "id": "ListInvitationsResponse"
}
- }
+ },
+ "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://classroom.googleapis.com/"
}
diff --git a/cloudbuild/v1/cloudbuild-api.json b/cloudbuild/v1/cloudbuild-api.json
index fee49bc..e47be0a 100644
--- a/cloudbuild/v1/cloudbuild-api.json
+++ b/cloudbuild/v1/cloudbuild-api.json
@@ -1,1076 +1,9 @@
{
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "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": {
- "properties": {},
- "id": "RetryBuildRequest",
- "description": "RetryBuildRequest specifies a build to retry.",
- "type": "object"
- },
- "BuildOperationMetadata": {
- "description": "Metadata for build operations.",
- "type": "object",
- "properties": {
- "build": {
- "$ref": "Build",
- "description": "The build that the operation is tracking."
- }
- },
- "id": "BuildOperationMetadata"
- },
- "SourceProvenance": {
- "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",
- "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build.",
- "type": "object"
- },
- "CancelOperationRequest": {
- "properties": {},
- "id": "CancelOperationRequest",
- "description": "The request message for Operations.CancelOperation.",
- "type": "object"
- },
- "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."
- },
- "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"
- },
- "RepoSource": {
- "properties": {
- "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"
- },
- "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"
- }
- },
- "id": "RepoSource",
- "description": "RepoSource describes the location of the source in a Google Cloud Source\nRepository.",
- "type": "object"
- },
- "BuildStep": {
- "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"
- },
- "id": {
- "description": "Optional unique identifier for this build step, used in wait_for to\nreference this build step as a dependency.",
- "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"
- }
- },
- "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"
- },
- "timing": {
- "description": "Stores timing information for executing this build step.",
- "$ref": "TimeSpan"
- },
- "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"
- }
- },
- "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"
- }
- },
- "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",
- "description": "BuildStep describes a step to perform in the build pipeline.",
- "type": "object"
- },
- "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": {
- "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"
- },
- "BuildTrigger": {
- "properties": {
- "id": {
- "description": "Unique identifier of the trigger.\n\n@OutputOnly",
- "type": "string"
- },
- "build": {
- "$ref": "Build",
- "description": "Contents of the build template."
- },
- "substitutions": {
- "description": "Substitutions data for Build resource.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "description": {
- "description": "Human-readable description of this trigger.",
- "type": "string"
- },
- "createTime": {
- "description": "Time when the trigger was created.\n\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "disabled": {
- "description": "If true, the trigger will never result in a build.",
- "type": "boolean"
- },
- "triggerTemplate": {
- "$ref": "RepoSource",
- "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."
- },
- "filename": {
- "description": "Path, from the source root, to a file whose contents is used for the\ntemplate.",
- "type": "string"
- }
- },
- "id": "BuildTrigger",
- "description": "Configuration for an automated build in response to source repository\nchanges.",
- "type": "object"
- },
- "Build": {
- "description": "A build resource in the Container Builder API.\n\nAt a high level, a Build describes where to find source code, how to build\nit (for example, the builder image to run on the source), and what tag to\napply to the built image when it is pushed to Google Container Registry.\n\nFields can include the following variables which will be expanded when the\nbuild is created:\n\n- $PROJECT_ID: the project ID of the build.\n- $BUILD_ID: the autogenerated ID of the build.\n- $REPO_NAME: the source repository name specified by RepoSource.\n- $BRANCH_NAME: the branch name specified by RepoSource.\n- $TAG_NAME: the tag name specified by RepoSource.\n- $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or\n resolved from the specified branch or tag.\n- $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.",
- "type": "object",
- "properties": {
- "buildTriggerId": {
- "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",
- "items": {
- "type": "string"
- }
- },
- "startTime": {
- "description": "Time at which execution of the build was started.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "substitutions": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Substitutions data for Build resource.",
- "type": "object"
- },
- "timing": {
- "additionalProperties": {
- "$ref": "TimeSpan"
- },
- "description": "Stores timing information for phases of the build.\nValid keys are:\n- BUILD: time to execute all build steps\n- PUSH: time to push all specified images.\n- FETCHSOURCE: time to fetch source.\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"
- },
- "options": {
- "$ref": "BuildOptions",
- "description": "Special options for this build."
- },
- "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"
- },
- "status": {
- "enumDescriptions": [
- "Status of the build is unknown.",
- "Build is queued; work has not yet begun.",
- "Build is being executed.",
- "Build finished successfully.",
- "Build failed to complete successfully.",
- "Build failed due to an internal cause.",
- "Build took longer than was allowed.",
- "Build was canceled by a user."
- ],
- "enum": [
- "STATUS_UNKNOWN",
- "QUEUED",
- "WORKING",
- "SUCCESS",
- "FAILURE",
- "INTERNAL_ERROR",
- "TIMEOUT",
- "CANCELLED"
- ],
- "description": "Status of the build.\n@OutputOnly",
- "type": "string"
- },
- "statusDetail": {
- "description": "Customer-readable message about the current status.\n@OutputOnly",
- "type": "string"
- },
- "secrets": {
- "description": "Secrets to decrypt using Cloud KMS.",
- "type": "array",
- "items": {
- "$ref": "Secret"
- }
- },
- "logsBucket": {
- "description": "Google Cloud Storage bucket where logs should be written (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\nLogs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.",
- "type": "string"
- },
- "results": {
- "$ref": "Results",
- "description": "Results of the build.\n@OutputOnly"
- },
- "steps": {
- "description": "Describes the operations to be performed on the workspace.",
- "type": "array",
- "items": {
- "$ref": "BuildStep"
- }
- }
- },
- "id": "Build"
- },
- "CancelBuildRequest": {
- "description": "Request to cancel an ongoing build.",
- "type": "object",
- "properties": {},
- "id": "CancelBuildRequest"
- },
- "ListBuildsResponse": {
- "properties": {
- "builds": {
- "description": "Builds will be sorted by create_time, descending.",
- "type": "array",
- "items": {
- "$ref": "Build"
- }
- },
- "nextPageToken": {
- "description": "Token to receive the next page of results.",
- "type": "string"
- }
- },
- "id": "ListBuildsResponse",
- "description": "Response including listed builds.",
- "type": "object"
- },
- "Volume": {
- "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"
- }
- },
- "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"
- },
- "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"
- },
- "TimeSpan": {
- "description": "Stores start and end times for a build execution phase.",
- "type": "object",
- "properties": {
- "endTime": {
- "description": "End of time span.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "Start of time span.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "TimeSpan"
- },
- "BuildOptions": {
- "description": "Optional arguments to enable specific features of builds.",
- "type": "object",
- "properties": {
- "machineType": {
- "description": "GCE VM size to run the build on.",
- "type": "string",
- "enumDescriptions": [
- "Standard machine type.",
- "Highcpu machine with 8 CPUs.",
- "Highcpu machine with 32 CPUs."
- ],
- "enum": [
- "UNSPECIFIED",
- "N1_HIGHCPU_8",
- "N1_HIGHCPU_32"
- ]
- },
- "logStreamingOption": {
- "enumDescriptions": [
- "Service may automatically determine build log streaming behavior.",
- "Build logs should be streamed to Google Cloud Storage.",
- "Build logs should not be streamed to Google Cloud Storage; they will be\nwritten when the build is completed."
- ],
- "enum": [
- "STREAM_DEFAULT",
- "STREAM_ON",
- "STREAM_OFF"
- ],
- "description": "LogStreamingOption to define build log streaming behavior to Google Cloud\nStorage.",
- "type": "string"
- },
- "substitutionOption": {
- "description": "SubstitutionOption to allow unmatch substitutions.",
- "type": "string",
- "enumDescriptions": [
- "Fails the build if error in substitutions checks, like missing\na substitution in the template or in the map.",
- "Do not fail the build if error in substitutions checks."
- ],
- "enum": [
- "MUST_MATCH",
- "ALLOW_LOOSE"
- ]
- },
- "requestedVerifyOption": {
- "description": "Requested verifiability options.",
- "type": "string",
- "enumDescriptions": [
- "Not a verifiable build. (default)",
- "Verified build."
- ],
- "enum": [
- "NOT_VERIFIED",
- "VERIFIED"
- ]
- },
- "diskSizeGb": {
- "description": "Requested disk size for the VM that runs the build. Note that this is *NOT*\n\"disk free\"; some of the space will be used by the operating system and\nbuild utilities. Also note that this is the minimum disk size that will be\nallocated for the build -- the build may run with a larger disk than\nrequested. At present, the maximum disk size is 1000GB; builds that request\nmore than the maximum are rejected with an error.",
- "format": "int64",
- "type": "string"
- },
- "sourceProvenanceHash": {
- "description": "Requested hash for SourceProvenance.",
- "type": "array",
- "items": {
- "enum": [
- "NONE",
- "SHA256"
- ],
- "type": "string"
- },
- "enumDescriptions": [
- "No hash requested.",
- "Use a sha256 hash."
- ]
- }
- },
- "id": "BuildOptions"
- },
- "StorageSource": {
- "description": "StorageSource describes the location of the source in an archive file in\nGoogle Cloud Storage.",
- "type": "object",
- "properties": {
- "generation": {
- "description": "Google Cloud Storage generation for the object. If the generation is\nomitted, the latest generation will be used.",
- "format": "int64",
- "type": "string"
- },
- "bucket": {
- "description": "Google Cloud Storage bucket containing source (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).",
- "type": "string"
- },
- "object": {
- "description": "Google Cloud Storage object containing source.\n\nThis object must be a gzipped archive file (.tar.gz) containing source to\nbuild.",
- "type": "string"
- }
- },
- "id": "StorageSource"
- },
- "Results": {
- "description": "Results describes the artifacts created by the build pipeline.",
- "type": "object",
- "properties": {
- "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"
- },
- "ListBuildTriggersResponse": {
- "properties": {
- "triggers": {
- "description": "BuildTriggers for the project, sorted by create_time descending.",
- "type": "array",
- "items": {
- "$ref": "BuildTrigger"
- }
- }
- },
- "id": "ListBuildTriggersResponse",
- "description": "Response containing existing BuildTriggers.",
- "type": "object"
- },
- "BuiltImage": {
- "description": "BuiltImage describes an image built by the pipeline.",
- "type": "object",
- "properties": {
- "pushTiming": {
- "description": "Stores timing information for pushing the specified image.",
- "$ref": "TimeSpan"
- },
- "name": {
- "description": "Name used to push the container image to Google Container Registry, as\npresented to `docker push`.",
- "type": "string"
- },
- "digest": {
- "description": "Docker Registry 2.0 digest.",
- "type": "string"
- }
- },
- "id": "BuiltImage"
- },
- "Hash": {
- "description": "Container message for hash values.",
- "type": "object",
- "properties": {
- "type": {
- "enumDescriptions": [
- "No hash requested.",
- "Use a sha256 hash."
- ],
- "enum": [
- "NONE",
- "SHA256"
- ],
- "description": "The type of hash that was performed.",
- "type": "string"
- },
- "value": {
- "description": "The hash value.",
- "format": "byte",
- "type": "string"
- }
- },
- "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"
- }
- }
- },
- "id": "Secret"
- },
- "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": {
- "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 Build",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://cloudbuild.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudbuild",
- "batchPath": "batch",
- "title": "Google Cloud Container Builder API",
"ownerName": "Google",
"resources": {
- "projects": {
- "resources": {
- "triggers": {
- "methods": {
- "get": {
- "description": "Gets information about a BuildTrigger.\n\nThis API is experimental.",
- "response": {
- "$ref": "BuildTrigger"
- },
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "triggerId": {
- "location": "path",
- "description": "ID of the BuildTrigger to get.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "ID of the project that owns the trigger.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
- "path": "v1/projects/{projectId}/triggers/{triggerId}",
- "id": "cloudbuild.projects.triggers.get"
- },
- "patch": {
- "response": {
- "$ref": "BuildTrigger"
- },
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "httpMethod": "PATCH",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
- "path": "v1/projects/{projectId}/triggers/{triggerId}",
- "id": "cloudbuild.projects.triggers.patch",
- "request": {
- "$ref": "BuildTrigger"
- },
- "description": "Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental."
- },
- "delete": {
- "description": "Deletes an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "triggerId": {
- "description": "ID of the BuildTrigger to delete.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "ID of the project that owns the trigger.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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"
- },
- "list": {
- "description": "Lists existing BuildTrigger.\n\nThis API is experimental.",
- "response": {
- "$ref": "ListBuildTriggersResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "projectId": {
- "description": "ID of the project for which to list BuildTriggers.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/triggers",
- "path": "v1/projects/{projectId}/triggers",
- "id": "cloudbuild.projects.triggers.list"
- },
- "create": {
- "request": {
- "$ref": "BuildTrigger"
- },
- "description": "Creates a new BuildTrigger.\n\nThis API is experimental.",
- "response": {
- "$ref": "BuildTrigger"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "ID of the project for which to configure automatic builds.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/triggers",
- "path": "v1/projects/{projectId}/triggers",
- "id": "cloudbuild.projects.triggers.create"
- },
- "run": {
- "description": "Runs a BuildTrigger at a particular source revision.",
- "request": {
- "$ref": "RepoSource"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- }
- },
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}:run",
- "path": "v1/projects/{projectId}/triggers/{triggerId}:run",
- "id": "cloudbuild.projects.triggers.run"
- }
- }
- },
- "builds": {
- "methods": {
- "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.",
- "response": {
- "$ref": "Build"
- },
- "parameterOrder": [
- "projectId",
- "id"
- ],
- "httpMethod": "GET",
- "parameters": {
- "projectId": {
- "description": "ID of the project.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "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}",
- "path": "v1/projects/{projectId}/builds/{id}",
- "id": "cloudbuild.projects.builds.get"
- },
- "list": {
- "description": "Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "ListBuildsResponse"
- },
- "parameters": {
- "filter": {
- "description": "The raw filter text to constrain the results.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "Token to provide to skip to a particular spot in the list.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Number of results to return in the list.",
- "format": "int32",
- "type": "integer"
- },
- "projectId": {
- "location": "path",
- "description": "ID of the project.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/builds",
- "id": "cloudbuild.projects.builds.list",
- "path": "v1/projects/{projectId}/builds"
- },
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "description": "ID of the project.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/builds",
- "path": "v1/projects/{projectId}/builds",
- "id": "cloudbuild.projects.builds.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)."
- },
- "cancel": {
- "path": "v1/projects/{projectId}/builds/{id}:cancel",
- "id": "cloudbuild.projects.builds.cancel",
- "description": "Cancels a requested build in progress.",
- "request": {
- "$ref": "CancelBuildRequest"
- },
- "response": {
- "$ref": "Build"
- },
- "parameterOrder": [
- "projectId",
- "id"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "ID of the project.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "id": {
- "description": "ID of the build.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/builds/{id}:cancel"
- },
- "retry": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "id"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "description": "ID of the project.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "id": {
- "description": "Build ID of the original build.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/builds/{id}:retry",
- "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."
- }
- }
- }
- }
- },
"operations": {
"methods": {
"list": {
- "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.",
"response": {
"$ref": "ListOperationsResponse"
@@ -1083,30 +16,33 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"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": "^operations$",
- "location": "path"
+ "pattern": "^operations$"
},
"pageToken": {
- "description": "The standard list page token.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "The standard list page token."
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "The standard list filter."
}
- }
+ },
+ "flatPath": "v1/operations",
+ "path": "v1/{+name}",
+ "id": "cloudbuild.operations.list"
},
"get": {
"response": {
@@ -1134,6 +70,13 @@
"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": {
+ "flatPath": "v1/operations/{operationsId}: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`.",
"response": {
"$ref": "Empty"
},
@@ -1141,39 +84,397 @@
"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": "^operations/.+$",
- "location": "path"
+ "pattern": "^operations/.+$"
}
},
- "flatPath": "v1/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "cloudbuild.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"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "builds": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "Build"
+ },
+ "parameterOrder": [
+ "projectId",
+ "id"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the project."
+ },
+ "id": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the build."
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/builds/{id}",
+ "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."
+ },
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Token to provide to skip to a particular spot in the list.",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Number of results to return in the list.",
+ "format": "int32"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project.",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "The raw filter text to constrain the results."
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/builds",
+ "path": "v1/projects/{projectId}/builds",
+ "id": "cloudbuild.projects.builds.list"
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/builds",
+ "path": "v1/projects/{projectId}/builds",
+ "id": "cloudbuild.projects.builds.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)."
+ },
+ "cancel": {
+ "flatPath": "v1/projects/{projectId}/builds/{id}:cancel",
+ "path": "v1/projects/{projectId}/builds/{id}:cancel",
+ "id": "cloudbuild.projects.builds.cancel",
+ "description": "Cancels a requested build in progress.",
+ "request": {
+ "$ref": "CancelBuildRequest"
+ },
+ "response": {
+ "$ref": "Build"
+ },
+ "parameterOrder": [
+ "projectId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project.",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the build."
+ }
+ }
+ },
+ "retry": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "id"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project.",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "location": "path",
+ "description": "Build ID of the original build.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/builds/{id}:retry",
+ "path": "v1/projects/{projectId}/builds/{id}:retry",
+ "id": "cloudbuild.projects.builds.retry",
+ "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.",
+ "request": {
+ "$ref": "RetryBuildRequest"
+ }
+ }
+ }
+ },
+ "triggers": {
+ "methods": {
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "triggerId": {
+ "location": "path",
+ "description": "ID of the BuildTrigger to get.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the project that owns the trigger."
+ }
+ }
+ },
+ "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": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the project that owns the trigger."
+ }
+ },
+ "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"
+ }
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the project that owns the trigger."
+ },
+ "triggerId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the BuildTrigger to delete."
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
+ "path": "v1/projects/{projectId}/triggers/{triggerId}",
+ "id": "cloudbuild.projects.triggers.delete",
+ "description": "Deletes an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "ListBuildTriggersResponse"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project for which to list BuildTriggers.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/triggers",
+ "id": "cloudbuild.projects.triggers.list",
+ "path": "v1/projects/{projectId}/triggers",
+ "description": "Lists existing BuildTrigger.\n\nThis API is experimental."
+ },
+ "create": {
+ "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"
+ },
+ "response": {
+ "$ref": "BuildTrigger"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project for which to configure automatic builds.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "run": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "triggerId": {
+ "location": "path",
+ "description": "ID of the trigger.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}:run",
+ "path": "v1/projects/{projectId}/triggers/{triggerId}:run",
+ "id": "cloudbuild.projects.triggers.run",
+ "description": "Runs a BuildTrigger at a particular source revision.",
+ "request": {
+ "$ref": "RepoSource"
+ }
+ }
}
}
}
}
},
"parameters": {
- "bearer_token": {
- "description": "OAuth bearer token.",
- "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"
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
+ },
+ "bearer_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth bearer token."
},
"upload_protocol": {
"location": "query",
@@ -1186,35 +487,36 @@
"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": {
- "description": "JSONP",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
+ },
+ "uploadType": {
+ "type": "string",
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
- "location": "query"
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format."
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
+ "default": "json",
"enum": [
"json",
"media",
@@ -1227,29 +529,22 @@
"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"
+ "description": "Data format for response."
},
"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.",
+ "description": "OAuth access token.",
"type": "string"
},
- "pp": {
+ "key": {
"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"
+ },
+ "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",
@@ -1258,7 +553,712 @@
"description": "Builds container images in the cloud.",
"kind": "discovery#restDescription",
"basePath": "",
- "id": "cloudbuild:v1",
"documentationLink": "https://cloud.google.com/container-builder/docs/",
- "revision": "20171214"
+ "revision": "20171214",
+ "id": "cloudbuild:v1",
+ "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": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ }
+ },
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
+ },
+ "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"
+ },
+ "BuildTrigger": {
+ "type": "object",
+ "properties": {
+ "triggerTemplate": {
+ "$ref": "RepoSource",
+ "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."
+ },
+ "filename": {
+ "description": "Path, from the source root, to a file whose contents is used for the\ntemplate.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the trigger.\n\n@OutputOnly",
+ "type": "string"
+ },
+ "build": {
+ "$ref": "Build",
+ "description": "Contents of the build template."
+ },
+ "substitutions": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Substitutions data for Build resource."
+ },
+ "description": {
+ "description": "Human-readable description of this trigger.",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "Time when the trigger was created.\n\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "disabled": {
+ "description": "If true, the trigger will never result in a build.",
+ "type": "boolean"
+ }
+ },
+ "id": "BuildTrigger",
+ "description": "Configuration for an automated build in response to source repository\nchanges."
+ },
+ "Build": {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "statusDetail": {
+ "description": "Customer-readable message about the current status.\n@OutputOnly",
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "STATUS_UNKNOWN",
+ "QUEUED",
+ "WORKING",
+ "SUCCESS",
+ "FAILURE",
+ "INTERNAL_ERROR",
+ "TIMEOUT",
+ "CANCELLED"
+ ],
+ "description": "Status of the build.\n@OutputOnly",
+ "type": "string",
+ "enumDescriptions": [
+ "Status of the build is unknown.",
+ "Build is queued; work has not yet begun.",
+ "Build is being executed.",
+ "Build finished successfully.",
+ "Build failed to complete successfully.",
+ "Build failed due to an internal cause.",
+ "Build took longer than was allowed.",
+ "Build was canceled by a user."
+ ]
+ },
+ "secrets": {
+ "description": "Secrets to decrypt using Cloud KMS.",
+ "type": "array",
+ "items": {
+ "$ref": "Secret"
+ }
+ },
+ "results": {
+ "$ref": "Results",
+ "description": "Results of the build.\n@OutputOnly"
+ },
+ "logsBucket": {
+ "type": "string",
+ "description": "Google Cloud Storage bucket where logs should be written (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\nLogs file names will be of the format `${logs_bucket}/log-${build_id}.txt`."
+ },
+ "steps": {
+ "type": "array",
+ "items": {
+ "$ref": "BuildStep"
+ },
+ "description": "Describes the operations to be performed on the workspace."
+ },
+ "buildTriggerId": {
+ "description": "The ID of the BuildTrigger that triggered this build, if it was\ntriggered automatically.\n@OutputOnly",
+ "type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "Unique identifier of the build.\n@OutputOnly"
+ },
+ "tags": {
+ "description": "Tags for annotation of a Build. These are not docker tags.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "startTime": {
+ "type": "string",
+ "description": "Time at which execution of the build was started.\n@OutputOnly",
+ "format": "google-datetime"
+ },
+ "substitutions": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Substitutions data for Build resource."
+ },
+ "timing": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "TimeSpan"
+ },
+ "description": "Stores timing information for phases of the build.\nValid keys are:\n- BUILD: time to execute all build steps\n- PUSH: time to push all specified images.\n- FETCHSOURCE: time to fetch source.\nIf the build does not specify source, or does not specify images,\nthese keys will not be included."
+ },
+ "createTime": {
+ "type": "string",
+ "description": "Time at which the request to create the build was received.\n@OutputOnly",
+ "format": "google-datetime"
+ },
+ "sourceProvenance": {
+ "$ref": "SourceProvenance",
+ "description": "A permanent fixed identifier for source.\n@OutputOnly"
+ },
+ "images": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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."
+ },
+ "projectId": {
+ "type": "string",
+ "description": "ID of the project.\n@OutputOnly."
+ },
+ "logUrl": {
+ "description": "URL to logs for this build in Google Cloud Logging.\n@OutputOnly",
+ "type": "string"
+ },
+ "finishTime": {
+ "type": "string",
+ "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"
+ },
+ "options": {
+ "$ref": "BuildOptions",
+ "description": "Special options for this build."
+ },
+ "source": {
+ "$ref": "Source",
+ "description": "Describes where to find the source files to build."
+ }
+ },
+ "id": "Build",
+ "description": "A build resource in the Container Builder API.\n\nAt a high level, a Build describes where to find source code, how to build\nit (for example, the builder image to run on the source), and what tag to\napply to the built image when it is pushed to Google Container Registry.\n\nFields can include the following variables which will be expanded when the\nbuild is created:\n\n- $PROJECT_ID: the project ID of the build.\n- $BUILD_ID: the autogenerated ID of the build.\n- $REPO_NAME: the source repository name specified by RepoSource.\n- $BRANCH_NAME: the branch name specified by RepoSource.\n- $TAG_NAME: the tag name specified by RepoSource.\n- $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or\n resolved from the specified branch or tag.\n- $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA."
+ },
+ "CancelBuildRequest": {
+ "description": "Request to cancel an ongoing build.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelBuildRequest"
+ },
+ "Volume": {
+ "type": "object",
+ "properties": {
+ "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."
+ },
+ "ListBuildsResponse": {
+ "description": "Response including listed builds.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token to receive the next page of results.",
+ "type": "string"
+ },
+ "builds": {
+ "description": "Builds will be sorted by create_time, descending.",
+ "type": "array",
+ "items": {
+ "$ref": "Build"
+ }
+ }
+ },
+ "id": "ListBuildsResponse"
+ },
+ "ListOperationsResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "The standard List next-page token."
+ },
+ "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."
+ },
+ "TimeSpan": {
+ "description": "Stores start and end times for a build execution phase.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "description": "End of time span.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Start of time span.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "TimeSpan"
+ },
+ "BuildOptions": {
+ "type": "object",
+ "properties": {
+ "machineType": {
+ "type": "string",
+ "enumDescriptions": [
+ "Standard machine type.",
+ "Highcpu machine with 8 CPUs.",
+ "Highcpu machine with 32 CPUs."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "N1_HIGHCPU_8",
+ "N1_HIGHCPU_32"
+ ],
+ "description": "GCE VM size to run the build on."
+ },
+ "logStreamingOption": {
+ "enum": [
+ "STREAM_DEFAULT",
+ "STREAM_ON",
+ "STREAM_OFF"
+ ],
+ "description": "LogStreamingOption to define build log streaming behavior to Google Cloud\nStorage.",
+ "type": "string",
+ "enumDescriptions": [
+ "Service may automatically determine build log streaming behavior.",
+ "Build logs should be streamed to Google Cloud Storage.",
+ "Build logs should not be streamed to Google Cloud Storage; they will be\nwritten when the build is completed."
+ ]
+ },
+ "requestedVerifyOption": {
+ "type": "string",
+ "enumDescriptions": [
+ "Not a verifiable build. (default)",
+ "Verified build."
+ ],
+ "enum": [
+ "NOT_VERIFIED",
+ "VERIFIED"
+ ],
+ "description": "Requested verifiability options."
+ },
+ "substitutionOption": {
+ "enum": [
+ "MUST_MATCH",
+ "ALLOW_LOOSE"
+ ],
+ "description": "SubstitutionOption to allow unmatch substitutions.",
+ "type": "string",
+ "enumDescriptions": [
+ "Fails the build if error in substitutions checks, like missing\na substitution in the template or in the map.",
+ "Do not fail the build if error in substitutions checks."
+ ]
+ },
+ "diskSizeGb": {
+ "type": "string",
+ "description": "Requested disk size for the VM that runs the build. Note that this is *NOT*\n\"disk free\"; some of the space will be used by the operating system and\nbuild utilities. Also note that this is the minimum disk size that will be\nallocated for the build -- the build may run with a larger disk than\nrequested. At present, the maximum disk size is 1000GB; builds that request\nmore than the maximum are rejected with an error.",
+ "format": "int64"
+ },
+ "sourceProvenanceHash": {
+ "description": "Requested hash for SourceProvenance.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "NONE",
+ "SHA256"
+ ],
+ "type": "string"
+ },
+ "enumDescriptions": [
+ "No hash requested.",
+ "Use a sha256 hash."
+ ]
+ }
+ },
+ "id": "BuildOptions",
+ "description": "Optional arguments to enable specific features of builds."
+ },
+ "StorageSource": {
+ "type": "object",
+ "properties": {
+ "bucket": {
+ "description": "Google Cloud Storage bucket containing source (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).",
+ "type": "string"
+ },
+ "object": {
+ "type": "string",
+ "description": "Google Cloud Storage object containing source.\n\nThis object must be a gzipped archive file (.tar.gz) containing source to\nbuild."
+ },
+ "generation": {
+ "description": "Google Cloud Storage generation for the object. If the generation is\nomitted, the latest generation will be used.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "StorageSource",
+ "description": "StorageSource describes the location of the source in an archive file in\nGoogle Cloud Storage."
+ },
+ "Results": {
+ "description": "Results describes the artifacts created by the build pipeline.",
+ "type": "object",
+ "properties": {
+ "buildStepImages": {
+ "description": "List of build step digests, in order corresponding to build step indices.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "images": {
+ "type": "array",
+ "items": {
+ "$ref": "BuiltImage"
+ },
+ "description": "Images that were built as a part of the build."
+ }
+ },
+ "id": "Results"
+ },
+ "ListBuildTriggersResponse": {
+ "description": "Response containing existing BuildTriggers.",
+ "type": "object",
+ "properties": {
+ "triggers": {
+ "description": "BuildTriggers for the project, sorted by create_time descending.",
+ "type": "array",
+ "items": {
+ "$ref": "BuildTrigger"
+ }
+ }
+ },
+ "id": "ListBuildTriggersResponse"
+ },
+ "BuiltImage": {
+ "type": "object",
+ "properties": {
+ "pushTiming": {
+ "$ref": "TimeSpan",
+ "description": "Stores timing information for pushing the specified image."
+ },
+ "name": {
+ "description": "Name used to push the container image to Google Container Registry, as\npresented to `docker push`.",
+ "type": "string"
+ },
+ "digest": {
+ "type": "string",
+ "description": "Docker Registry 2.0 digest."
+ }
+ },
+ "id": "BuiltImage",
+ "description": "BuiltImage describes an image built by the pipeline."
+ },
+ "Hash": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "enum": [
+ "NONE",
+ "SHA256"
+ ],
+ "description": "The type of hash that was performed.",
+ "type": "string",
+ "enumDescriptions": [
+ "No hash requested.",
+ "Use a sha256 hash."
+ ]
+ },
+ "value": {
+ "type": "string",
+ "description": "The hash value.",
+ "format": "byte"
+ }
+ },
+ "id": "Hash",
+ "description": "Container message for hash values."
+ },
+ "Secret": {
+ "type": "object",
+ "properties": {
+ "kmsKeyName": {
+ "type": "string",
+ "description": "Cloud KMS key name to use to decrypt these envs."
+ },
+ "secretEnv": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string",
+ "format": "byte"
+ },
+ "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."
+ }
+ },
+ "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."
+ },
+ "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": {
+ "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",
+ "description": "Source describes the location of the source in a supported storage\nservice."
+ },
+ "RetryBuildRequest": {
+ "description": "RetryBuildRequest specifies a build to retry.",
+ "type": "object",
+ "properties": {},
+ "id": "RetryBuildRequest"
+ },
+ "BuildOperationMetadata": {
+ "type": "object",
+ "properties": {
+ "build": {
+ "$ref": "Build",
+ "description": "The build that the operation is tracking."
+ }
+ },
+ "id": "BuildOperationMetadata",
+ "description": "Metadata for build operations."
+ },
+ "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": {
+ "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."
+ },
+ "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"
+ }
+ },
+ "id": "SourceProvenance"
+ },
+ "CancelOperationRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "CancelOperationRequest",
+ "description": "The request message for Operations.CancelOperation."
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "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": {
+ "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`.",
+ "type": "object"
+ },
+ "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."
+ }
+ },
+ "id": "Operation"
+ },
+ "BuildStep": {
+ "description": "BuildStep describes a step to perform in the build pipeline.",
+ "type": "object",
+ "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": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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\"."
+ },
+ "waitFor": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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."
+ },
+ "timing": {
+ "$ref": "TimeSpan",
+ "description": "Stores timing information for executing this build step."
+ },
+ "args": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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."
+ },
+ "name": {
+ "type": "string",
+ "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."
+ },
+ "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"
+ },
+ "RepoSource": {
+ "description": "RepoSource describes the location of the source in a Google Cloud Source\nRepository.",
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "description": "ID of the project that owns the repo. If omitted, the project ID requesting\nthe build is assumed.",
+ "type": "string"
+ },
+ "repoName": {
+ "description": "Name of the repo. If omitted, the name \"default\" is assumed.",
+ "type": "string"
+ },
+ "commitSha": {
+ "type": "string",
+ "description": "Explicit commit SHA to build."
+ },
+ "dir": {
+ "type": "string",
+ "description": "Directory, relative to the source root, in which to run the build."
+ },
+ "branchName": {
+ "description": "Name of the branch to build.",
+ "type": "string"
+ },
+ "tagName": {
+ "description": "Name of the tag to build.",
+ "type": "string"
+ }
+ },
+ "id": "RepoSource"
+ },
+ "FileHashes": {
+ "type": "object",
+ "properties": {
+ "fileHash": {
+ "type": "array",
+ "items": {
+ "$ref": "Hash"
+ },
+ "description": "Collection of file hashes."
+ }
+ },
+ "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."
+ }
+ },
+ "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 Build",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://cloudbuild.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudbuild",
+ "batchPath": "batch",
+ "title": "Google Cloud Container Builder API"
}
diff --git a/clouddebugger/v2/clouddebugger-api.json b/clouddebugger/v2/clouddebugger-api.json
index e16398c..1345f03 100644
--- a/clouddebugger/v2/clouddebugger-api.json
+++ b/clouddebugger/v2/clouddebugger-api.json
@@ -1,18 +1,644 @@
{
- "revision": "20171016",
- "documentationLink": "http://cloud.google.com/debugger",
+ "title": "Stackdriver Debugger API",
+ "ownerName": "Google",
+ "resources": {
+ "debugger": {
+ "resources": {
+ "debuggees": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListDebuggeesResponse"
+ },
+ "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",
+ "id": "clouddebugger.debugger.debuggees.list",
+ "path": "v2/debugger/debuggees",
+ "description": "Lists all the debuggees that the user has access to."
+ }
+ },
+ "resources": {
+ "breakpoints": {
+ "methods": {
+ "set": {
+ "response": {
+ "$ref": "SetBreakpointResponse"
+ },
+ "parameterOrder": [
+ "debuggeeId"
+ ],
+ "httpMethod": "POST",
+ "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"
+ }
+ },
+ "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",
+ "request": {
+ "$ref": "Breakpoint"
+ },
+ "description": "Sets the breakpoint to the debuggee."
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "debuggeeId",
+ "breakpointId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "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"
+ }
+ },
+ "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": {
+ "description": "Gets breakpoint information.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "debuggeeId",
+ "breakpointId"
+ ],
+ "response": {
+ "$ref": "GetBreakpointResponse"
+ },
+ "parameters": {
+ "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"
+ },
+ "breakpointId": {
+ "location": "path",
+ "description": "ID of the breakpoint to get.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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": {
+ "description": "Lists all breakpoints for the debuggee.",
+ "response": {
+ "$ref": "ListBreakpointsResponse"
+ },
+ "parameterOrder": [
+ "debuggeeId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "parameters": {
+ "debuggeeId": {
+ "location": "path",
+ "description": "ID of the debuggee whose breakpoints to list.",
+ "required": true,
+ "type": "string"
+ },
+ "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": {
+ "description": "Only breakpoints with the specified action will pass the filter.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "CAPTURE",
+ "LOG"
+ ]
+ },
+ "includeInactive": {
+ "location": "query",
+ "description": "When set to `true`, the response includes active and inactive\nbreakpoints. Otherwise, it includes only active breakpoints.",
+ "type": "boolean"
+ },
+ "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"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.list"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "RegisterDebuggeeResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "flatPath": "v2/controller/debuggees/register",
+ "id": "clouddebugger.controller.debuggees.register",
+ "path": "v2/controller/debuggees/register"
+ }
+ },
+ "resources": {
+ "breakpoints": {
+ "methods": {
+ "list": {
+ "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",
+ "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."
+ },
+ "update": {
+ "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
+ "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
+ "id": "clouddebugger.controller.debuggees.breakpoints.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.",
+ "response": {
+ "$ref": "UpdateActiveBreakpointResponse"
+ },
+ "parameterOrder": [
+ "debuggeeId",
+ "id"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "debuggeeId": {
+ "description": "Identifies the debuggee being debugged.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "id": {
+ "description": "Breakpoint identifier, unique in the scope of the debuggee.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "version": "v2",
+ "baseUrl": "https://clouddebugger.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Examines the call stack and variables of a running application without stopping or slowing it down.\n",
+ "servicePath": "",
+ "basePath": "",
"id": "clouddebugger:v2",
+ "documentationLink": "http://cloud.google.com/debugger",
+ "revision": "20171016",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "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": {
+ "$ref": "AliasContext",
+ "description": "An alias, which may be a branch or tag."
+ },
+ "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": {
+ "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"
+ },
+ "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": {
+ "status": {
+ "$ref": "StatusMessage",
+ "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"
+ },
+ "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"
+ }
+ },
+ "createTime": {
+ "description": "Time this breakpoint was created by the server in seconds resolution.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "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": {
+ "description": "A set of custom breakpoint properties, populated by the agent, to be\ndisplayed to the user.",
+ "type": "object",
+ "additionalProperties": {
+ "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"
+ }
+ },
+ "id": "Breakpoint"
+ },
+ "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"
+ },
+ "SetBreakpointResponse": {
+ "description": "Response for setting a breakpoint.",
+ "type": "object",
+ "properties": {
+ "breakpoint": {
+ "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds).",
+ "$ref": "Breakpoint"
+ }
+ },
+ "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": {
+ "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": {
+ "description": "A SourceContext referring to a revision in a cloud repo.",
+ "$ref": "CloudRepoSourceContext"
+ },
+ "cloudWorkspace": {
+ "description": "A SourceContext referring to a snapshot in a cloud workspace.",
+ "$ref": "CloudWorkspaceSourceContext"
+ }
+ },
+ "id": "SourceContext"
+ },
"CloudRepoSourceContext": {
"description": "A CloudRepoSourceContext denotes a particular revision in a cloud\nrepo (a repo hosted by the Google Cloud Platform).",
"type": "object",
"properties": {
- "aliasContext": {
- "description": "An alias, which may be a branch or tag.",
- "$ref": "AliasContext"
- },
"revisionId": {
"description": "A revision ID.",
"type": "string"
@@ -22,44 +648,48 @@
"type": "string"
},
"repoId": {
- "description": "The ID of the repo.",
- "$ref": "RepoId"
+ "$ref": "RepoId",
+ "description": "The ID of the repo."
+ },
+ "aliasContext": {
+ "description": "An alias, which may be a branch or tag.",
+ "$ref": "AliasContext"
}
},
"id": "CloudRepoSourceContext"
},
- "RegisterDebuggeeRequest": {
- "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",
- "description": "Request to register a debuggee.",
- "type": "object"
- },
"RegisterDebuggeeResponse": {
+ "description": "Response for registering a debuggee.",
+ "type": "object",
"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."
+ "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",
- "description": "Response for registering a debuggee.",
- "type": "object"
+ "id": "RegisterDebuggeeResponse"
+ },
+ "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"
},
"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"
+ "$ref": "Breakpoint",
+ "description": "Complete breakpoint state.\nThe fields `id` and `location` are guaranteed to be set."
}
},
- "id": "GetBreakpointResponse",
- "description": "Response for getting breakpoint information.",
- "type": "object"
+ "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`.",
@@ -114,6 +744,8 @@
"id": "GitSourceContext"
},
"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": {
"members": {
"description": "Members contained or pointed to by the variable.",
@@ -123,8 +755,8 @@
}
},
"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"
+ "$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.",
@@ -134,28 +766,22 @@
"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"
},
- "value": {
- "description": "Simple value of the variable.",
- "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"
}
},
- "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"
+ "id": "Variable"
},
"StackFrame": {
"description": "Represents a stack frame context.",
"type": "object",
"properties": {
- "function": {
- "description": "Demangled function name at the call site.",
- "type": "string"
- },
"arguments": {
"description": "Set of arguments passed to this function.\nNote that this might not be populated for all stack frames.",
"type": "array",
@@ -173,87 +799,64 @@
"location": {
"description": "Source location of the call site.",
"$ref": "SourceLocation"
+ },
+ "function": {
+ "description": "Demangled function name at the call site.",
+ "type": "string"
}
},
"id": "StackFrame"
},
"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"
+ "$ref": "ProjectRepoId",
+ "description": "A combination of a project ID and a repo name."
},
"uid": {
"description": "A server-assigned, globally unique identifier.",
"type": "string"
}
},
- "id": "RepoId",
- "description": "A unique identifier for a cloud repo.",
- "type": "object"
+ "id": "RepoId"
},
"FormatMessage": {
"description": "Represents a message with parameters.",
"type": "object",
"properties": {
+ "format": {
+ "description": "Format template for the message. The `format` uses placeholders `$0`,\n`$1`, etc. to reference parameters. `$$` can be used to denote the `$`\ncharacter.\n\nExamples:\n\n* `Failed to load '$0' which helps debug $1 the first time it\n is loaded. Again, $0 is very important.`\n* `Please pay $$10 to use $0 instead of $1.`",
+ "type": "string"
+ },
"parameters": {
"description": "Optional parameters to be embedded into the message.",
"type": "array",
"items": {
"type": "string"
}
- },
- "format": {
- "description": "Format template for the message. The `format` uses placeholders `$0`,\n`$1`, etc. to reference parameters. `$$` can be used to denote the `$`\ncharacter.\n\nExamples:\n\n* `Failed to load '$0' which helps debug $1 the first time it\n is loaded. Again, $0 is very important.`\n* `Please pay $$10 to use $0 instead of $1.`",
- "type": "string"
}
},
"id": "FormatMessage"
},
"ExtendedSourceContext": {
+ "description": "An ExtendedSourceContext is a SourceContext combined with additional\ndetails describing the context.",
+ "type": "object",
"properties": {
"context": {
"description": "Any source context.",
"$ref": "SourceContext"
},
"labels": {
+ "description": "Labels with user defined metadata.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Labels with user defined metadata.",
- "type": "object"
+ }
}
},
- "id": "ExtendedSourceContext",
- "description": "An ExtendedSourceContext is a SourceContext combined with additional\ndetails describing the context.",
- "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.",
- "Git tag",
- "Git branch",
- "OTHER is used to specify non-standard aliases, those not of the kinds\nabove. For example, if a Git repo has a ref named \"refs/foo/bar\", it\nis considered to be of kind OTHER."
- ],
- "enum": [
- "ANY",
- "FIXED",
- "MOVABLE",
- "OTHER"
- ],
- "description": "The alias kind.",
- "type": "string"
- }
- },
- "id": "AliasContext"
+ "id": "ExtendedSourceContext"
},
"ListDebuggeesResponse": {
"description": "Response for listing debuggees.",
@@ -269,6 +872,33 @@
},
"id": "ListDebuggeesResponse"
},
+ "AliasContext": {
+ "description": "An alias to a repo revision.",
+ "type": "object",
+ "properties": {
+ "kind": {
+ "description": "The alias kind.",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use.",
+ "Git tag",
+ "Git branch",
+ "OTHER is used to specify non-standard aliases, those not of the kinds\nabove. For example, if a Git repo has a ref named \"refs/foo/bar\", it\nis considered to be of kind OTHER."
+ ],
+ "enum": [
+ "ANY",
+ "FIXED",
+ "MOVABLE",
+ "OTHER"
+ ]
+ },
+ "name": {
+ "description": "The alias name.",
+ "type": "string"
+ }
+ },
+ "id": "AliasContext"
+ },
"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",
@@ -276,25 +906,41 @@
"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",
- "description": "Represents a location in the source code.",
- "type": "object"
+ "id": "SourceLocation"
},
"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": {
+ "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"
+ },
"uniquifier": {
"description": "Uniquifier to further distiguish the application.\nIt is possible that different applications might have identical values in\nthe debuggee message, thus, incorrectly identified as a single application\nby the Controller service. This field adds salt to further distiguish the\napplication. Agents should consider seeding this field with value that\nidentifies the code, binary, configuration and environment.",
"type": "string"
@@ -318,40 +964,26 @@
}
},
"labels": {
+ "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "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"
- },
- "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": "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.",
+ "$ref": "StatusMessage"
}
},
"id": "Debuggee"
},
"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.",
@@ -369,9 +1001,7 @@
"type": "boolean"
}
},
- "id": "ListActiveBreakpointsResponse",
- "description": "Response for listing active breakpoints.",
- "type": "object"
+ "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.",
@@ -389,243 +1019,26 @@
"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",
- "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.",
- "type": "object"
- },
- "GerritSourceContext": {
- "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": {
- "$ref": "AliasContext",
- "description": "An alias, which may be a branch or tag."
- },
- "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.).",
+ "snapshotId": {
+ "description": "The ID of the snapshot.\nAn empty snapshot_id refers to the most recent snapshot.",
"type": "string"
}
},
- "id": "GerritSourceContext",
- "description": "A SourceContext referring to a Gerrit project.",
- "type": "object"
- },
- "UpdateActiveBreakpointResponse": {
- "properties": {},
- "id": "UpdateActiveBreakpointResponse",
- "description": "Response for updating an active breakpoint.\nThe message is defined to allow future extensions.",
- "type": "object"
- },
- "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": {
- "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": {
- "description": "Represents the breakpoint specification, status and results.",
- "type": "object",
- "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": {
- "enum": [
- "INFO",
- "WARNING",
- "ERROR"
- ],
- "description": "Indicates the severity of the log. Only relevant when action is `LOG`.",
- "type": "string",
- "enumDescriptions": [
- "Information log message.",
- "Warning log message.",
- "Error log message."
- ]
- },
- "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"
- }
- },
- "createTime": {
- "description": "Time this breakpoint was created by the server in seconds resolution.",
- "format": "google-datetime",
- "type": "string"
- },
- "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"
- },
- "description": "A set of custom breakpoint properties, populated by the agent, to be\ndisplayed to the user.",
- "type": "object"
- },
- "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"
- },
- "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": {
- "properties": {
- "breakpoint": {
- "$ref": "Breakpoint",
- "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds)."
- }
- },
- "id": "SetBreakpointResponse",
- "description": "Response for setting a breakpoint.",
- "type": "object"
- },
- "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": {
- "description": "A SourceContext referring to any third party Git repo (e.g. GitHub).",
- "$ref": "GitSourceContext"
- },
- "gerrit": {
- "$ref": "GerritSourceContext",
- "description": "A SourceContext referring to a Gerrit project."
- },
- "cloudRepo": {
- "description": "A SourceContext referring to a revision in a cloud repo.",
- "$ref": "CloudRepoSourceContext"
- },
- "cloudWorkspace": {
- "$ref": "CloudWorkspaceSourceContext",
- "description": "A SourceContext referring to a snapshot in a cloud workspace."
- }
- },
- "id": "SourceContext"
+ "id": "CloudWorkspaceSourceContext"
}
},
- "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 Debugger",
"auth": {
"oauth2": {
@@ -642,418 +1055,5 @@
"rootUrl": "https://clouddebugger.googleapis.com/",
"ownerDomain": "google.com",
"name": "clouddebugger",
- "batchPath": "batch",
- "title": "Stackdriver Debugger API",
- "ownerName": "Google",
- "resources": {
- "debugger": {
- "resources": {
- "debuggees": {
- "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": {
- "location": "path",
- "description": "ID of the breakpoint to delete.",
- "required": true,
- "type": "string"
- },
- "debuggeeId": {
- "location": "path",
- "description": "ID of the debuggee whose breakpoint to delete.",
- "required": true,
- "type": "string"
- }
- },
- "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": {
- "description": "Gets breakpoint information.",
- "response": {
- "$ref": "GetBreakpointResponse"
- },
- "parameterOrder": [
- "debuggeeId",
- "breakpointId"
- ],
- "httpMethod": "GET",
- "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 get.",
- "required": true,
- "type": "string"
- },
- "debuggeeId": {
- "location": "path",
- "description": "ID of the debuggee whose breakpoint to get.",
- "required": true,
- "type": "string"
- }
- },
- "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.get"
- },
- "list": {
- "id": "clouddebugger.debugger.debuggees.breakpoints.list",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
- "description": "Lists all breakpoints for the debuggee.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListBreakpointsResponse"
- },
- "parameterOrder": [
- "debuggeeId"
- ],
- "parameters": {
- "includeInactive": {
- "location": "query",
- "description": "When set to `true`, the response includes active and inactive\nbreakpoints. Otherwise, it includes only active breakpoints.",
- "type": "boolean"
- },
- "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"
- },
- "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": {
- "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": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints"
- }
- }
- }
- },
- "methods": {
- "list": {
- "description": "Lists all the debuggees that the user has access to.",
- "response": {
- "$ref": "ListDebuggeesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "parameters": {
- "includeInactive": {
- "location": "query",
- "description": "When set to `true`, the result includes all debuggees. Otherwise, the\nresult includes only debuggees that are active.",
- "type": "boolean"
- },
- "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"
- }
- },
- "flatPath": "v2/debugger/debuggees",
- "path": "v2/debugger/debuggees",
- "id": "clouddebugger.debugger.debuggees.list"
- }
- }
- }
- }
- },
- "controller": {
- "resources": {
- "debuggees": {
- "resources": {
- "breakpoints": {
- "methods": {
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "debuggeeId",
- "id"
- ],
- "response": {
- "$ref": "UpdateActiveBreakpointResponse"
- },
- "parameters": {
- "id": {
- "location": "path",
- "description": "Breakpoint identifier, unique in the scope of the debuggee.",
- "required": true,
- "type": "string"
- },
- "debuggeeId": {
- "location": "path",
- "description": "Identifies the debuggee being debugged.",
- "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}",
- "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."
- },
- "list": {
- "response": {
- "$ref": "ListActiveBreakpointsResponse"
- },
- "parameterOrder": [
- "debuggeeId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "debuggeeId": {
- "location": "path",
- "description": "Identifies the debuggee.",
- "required": true,
- "type": "string"
- },
- "successOnTimeout": {
- "location": "query",
- "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"
- },
- "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",
- "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."
- }
- }
- }
- },
- "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"
- }
- }
- }
- }
- }
- },
- "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": {
- "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": {
- "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"
- },
- "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": "v2",
- "baseUrl": "https://clouddebugger.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Examines the call stack and variables of a running application without stopping or slowing it down.\n",
- "servicePath": "",
- "basePath": ""
+ "batchPath": "batch"
}
diff --git a/clouderrorreporting/v1beta1/clouderrorreporting-api.json b/clouderrorreporting/v1beta1/clouderrorreporting-api.json
index 2874327..aa75145 100644
--- a/clouderrorreporting/v1beta1/clouderrorreporting-api.json
+++ b/clouderrorreporting/v1beta1/clouderrorreporting-api.json
@@ -1,31 +1,174 @@
{
+ "id": "clouderrorreporting:v1beta1",
+ "documentationLink": "https://cloud.google.com/error-reporting/",
+ "revision": "20171208",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "ListEventsResponse": {
- "description": "Contains a set of requested error events.",
+ "ErrorEvent": {
+ "description": "An error event which is returned by the Error Reporting system.",
"type": "object",
"properties": {
- "timeRangeBegin": {
- "description": "The timestamp specifies the start time to which the request was restricted.",
+ "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"
},
+ "context": {
+ "$ref": "ErrorContext",
+ "description": "Data about the context in which the error occurred."
+ },
+ "message": {
+ "type": "string",
+ "description": "The stack trace that was reported or logged by the service."
+ }
+ },
+ "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": {
+ "type": "string",
+ "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"
+ },
+ "context": {
+ "$ref": "ErrorContext",
+ "description": "[Optional] A description of the context in which the error occurred."
+ },
+ "message": {
+ "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"
+ },
+ "ErrorContext": {
+ "type": "object",
+ "properties": {
+ "httpRequest": {
+ "$ref": "HttpRequestContext",
+ "description": "The HTTP request which was processed when the error was\ntriggered."
+ },
+ "user": {
+ "type": "string",
+ "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`."
+ },
+ "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"
+ }
+ }
+ },
+ "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."
+ },
+ "TrackingIssue": {
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string",
+ "description": "A URL pointing to a related entry in an issue tracking system.\nExample: https://github.com/user/project/issues/4"
+ }
+ },
+ "id": "TrackingIssue",
+ "description": "Information related to tracking the progress on resolving the error."
+ },
+ "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": {
+ "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."
+ },
+ "timedCounts": {
+ "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."
+ },
+ "group": {
+ "$ref": "ErrorGroup",
+ "description": "Group data that is independent of the filter criteria."
+ },
+ "firstSeenTime": {
+ "description": "Approximate first occurrence that was ever seen for this group\nand which matches the given filter criteria, ignoring the\ntime_range that was specified in the request.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "count": {
+ "type": "string",
+ "description": "Approximate total number of events in the given group that match\nthe filter criteria.",
+ "format": "int64"
+ },
+ "affectedUsersCount": {
+ "type": "string",
+ "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.",
+ "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"
+ },
+ "numAffectedServices": {
+ "type": "integer",
+ "description": "The total number of services with a non-zero error count for the given\nfilter criteria.",
+ "format": "int32"
+ },
+ "affectedServices": {
+ "type": "array",
+ "items": {
+ "$ref": "ServiceContext"
+ },
+ "description": "Service contexts with a non-zero error count for the given filter\ncriteria. This list can be truncated if multiple services are affected.\nRefer to `num_affected_services` for the total count."
+ }
+ },
+ "id": "ErrorGroupStats"
+ },
+ "ListEventsResponse": {
+ "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": {
+ "type": "string",
+ "description": "The timestamp specifies the start time to which the request was restricted.",
+ "format": "google-datetime"
+ },
"errorEvents": {
"type": "array",
"items": {
"$ref": "ErrorEvent"
},
"description": "The error events which match the given request."
- },
- "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"
+ "id": "ListEventsResponse",
+ "description": "Contains a set of requested error events."
},
"TimedCount": {
+ "description": "The number of errors in a given time period.\nAll numbers are approximate since the error events are sampled\nbefore counting them.",
"type": "object",
"properties": {
"endTime": {
@@ -34,9 +177,9 @@
"type": "string"
},
"count": {
- "type": "string",
"description": "Approximate number of occurrences in the given time period.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"startTime": {
"type": "string",
@@ -44,19 +187,14 @@
"format": "google-datetime"
}
},
- "id": "TimedCount",
- "description": "The number of errors in a given time period.\nAll numbers are approximate since the error events are sampled\nbefore counting them."
+ "id": "TimedCount"
},
"ErrorGroup": {
"type": "object",
"properties": {
- "name": {
- "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
- "type": "string"
- },
"groupId": {
- "type": "string",
- "description": "Group IDs are unique for a given project. If the same kind of error\noccurs in different service contexts, it will receive the same group ID."
+ "description": "Group IDs are unique for a given project. If the same kind of error\noccurs in different service contexts, it will receive the same group ID.",
+ "type": "string"
},
"trackingIssues": {
"description": "Associated tracking issues.",
@@ -64,21 +202,26 @@
"items": {
"$ref": "TrackingIssue"
}
+ },
+ "name": {
+ "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
+ "type": "string"
}
},
"id": "ErrorGroup",
"description": "Description of a group of similar error events."
},
"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": {
- "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."
+ "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": {
- "type": "string",
- "description": "The source code filename, which can include a truncated relative\npath, or a full path from a production machine."
+ "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.",
@@ -86,19 +229,18 @@
"type": "integer"
}
},
- "id": "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."
+ "id": "SourceLocation"
},
"ServiceContext": {
"type": "object",
"properties": {
"service": {
- "type": "string",
- "description": "An identifier of the service, such as the name of the\nexecutable, job, or Google App Engine service name. This field is expected\nto have a low number of values that are relatively stable over time, as\nopposed to `version`, which can be changed whenever new code is deployed.\n\nContains the service name for error reports extracted from Google\nApp Engine logs or `default` if the App Engine default service is used."
+ "description": "An identifier of the service, such as the name of the\nexecutable, job, or Google App Engine service name. This field is expected\nto have a low number of values that are relatively stable over time, as\nopposed to `version`, which can be changed whenever new code is deployed.\n\nContains the service name for error reports extracted from Google\nApp Engine logs or `default` if the App Engine default service is used.",
+ "type": "string"
},
"resourceType": {
- "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."
+ "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"
},
"version": {
"type": "string",
@@ -109,13 +251,12 @@
"description": "Describes a running service that sends errors.\nIts version changes over time and multiple versions can run in parallel."
},
"ReportErrorEventResponse": {
+ "description": "Response for reporting an individual error event.\nData may be added to this message in the future.",
"type": "object",
"properties": {},
- "id": "ReportErrorEventResponse",
- "description": "Response for reporting an individual error event.\nData may be added to this message in the future."
+ "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": {
"responseStatusCode": {
@@ -124,47 +265,48 @@
"format": "int32"
},
"method": {
- "type": "string",
- "description": "The type of HTTP request, such as `GET`, `POST`, etc."
+ "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"
+ "type": "string",
+ "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."
},
"referrer": {
"description": "The referrer information that is provided with the request.",
"type": "string"
},
"userAgent": {
- "type": "string",
- "description": "The user agent information that is provided with the request."
+ "description": "The user agent information that is provided with the request.",
+ "type": "string"
},
"url": {
"description": "The URL of the request.",
"type": "string"
}
},
- "id": "HttpRequestContext"
+ "id": "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."
},
"ListGroupStatsResponse": {
"description": "Contains a set of requested error group stats.",
"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": {
"type": "string",
"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"
},
"errorGroupStats": {
+ "description": "The error group stats which match the given request.",
"type": "array",
"items": {
"$ref": "ErrorGroupStats"
- },
- "description": "The error group stats which match the given request."
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "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."
}
},
"id": "ListGroupStatsResponse"
@@ -176,158 +318,19 @@
"id": "DeleteEventsResponse"
},
"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",
- "description": "A reference to a particular snapshot of the source tree used to build and\ndeploy an application."
- },
- "ErrorEvent": {
- "type": "object",
- "properties": {
- "context": {
- "$ref": "ErrorContext",
- "description": "Data about the context in which the error occurred."
},
- "message": {
- "type": "string",
- "description": "The stack trace that was reported or logged by the service."
- },
- "serviceContext": {
- "$ref": "ServiceContext",
- "description": "The `ServiceContext` for which this error was reported."
- },
- "eventTime": {
- "type": "string",
- "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"
- }
- },
- "id": "ErrorEvent",
- "description": "An error event which is returned by the Error Reporting system."
- },
- "ReportedErrorEvent": {
- "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": {
- "$ref": "ErrorContext",
- "description": "[Optional] A description of the context in which the error occurred."
- },
- "message": {
- "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",
- "description": "An error event which is reported to the Error Reporting system."
- },
- "ErrorContext": {
- "type": "object",
- "properties": {
- "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"
- }
- },
- "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`.",
+ "revisionId": {
+ "description": "The canonical and persistent identifier of the deployed revision.\nExample (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
"type": "string"
}
},
- "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."
- },
- "TrackingIssue": {
- "type": "object",
- "properties": {
- "url": {
- "description": "A URL pointing to a related entry in an issue tracking system.\nExample: https://github.com/user/project/issues/4",
- "type": "string"
- }
- },
- "id": "TrackingIssue",
- "description": "Information related to tracking the progress on resolving the error."
- },
- "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": {
- "$ref": "ErrorGroup",
- "description": "Group data that is independent of the filter criteria."
- },
- "firstSeenTime": {
- "type": "string",
- "description": "Approximate first occurrence that was ever seen for this group\nand which matches the given filter criteria, ignoring the\ntime_range that was specified in the request.",
- "format": "google-datetime"
- },
- "count": {
- "description": "Approximate total number of events in the given group that match\nthe filter criteria.",
- "format": "int64",
- "type": "string"
- },
- "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"
- },
- "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.",
- "format": "int64",
- "type": "string"
- },
- "numAffectedServices": {
- "description": "The total number of services with a non-zero error count for the given\nfilter criteria.",
- "format": "int32",
- "type": "integer"
- },
- "affectedServices": {
- "type": "array",
- "items": {
- "$ref": "ServiceContext"
- },
- "description": "Service contexts with a non-zero error count for the given filter\ncriteria. This list can be truncated if multiple services are affected.\nRefer to `num_affected_services` for the total count."
- },
- "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."
- },
- "timedCounts": {
- "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": "SourceReference"
}
},
"icons": {
@@ -355,6 +358,7 @@
"projects": {
"methods": {
"deleteEvents": {
+ "description": "Deletes all error events of a given project.",
"response": {
"$ref": "DeleteEventsResponse"
},
@@ -362,55 +366,39 @@
"projectName"
],
"httpMethod": "DELETE",
+ "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\nID](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"
],
- "parameters": {
- "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",
"path": "v1beta1/{+projectName}/events",
- "id": "clouderrorreporting.projects.deleteEvents",
- "description": "Deletes all error events of a given project."
+ "id": "clouderrorreporting.projects.deleteEvents"
}
},
"resources": {
"events": {
"methods": {
"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"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "[Optional] A `next_page_token` provided by a previous response.",
- "type": "string"
- },
- "serviceFilter.service": {
- "type": "string",
- "location": "query",
- "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service)."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "[Optional] The maximum number of results to return per response.",
- "format": "int32"
- },
"serviceFilter.version": {
"location": "query",
"description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
@@ -422,7 +410,6 @@
"type": "string"
},
"timeRange.period": {
- "type": "string",
"location": "query",
"enum": [
"PERIOD_UNSPECIFIED",
@@ -432,34 +419,57 @@
"PERIOD_1_WEEK",
"PERIOD_30_DAYS"
],
- "description": "Restricts the query to the specified time range."
+ "description": "Restricts the query to the specified time range.",
+ "type": "string"
},
"projectName": {
- "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`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+$"
+ "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`."
},
"groupId": {
"type": "string",
"location": "query",
"description": "[Required] The group for which events shall be returned."
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "[Optional] A `next_page_token` provided by a previous response."
+ },
+ "serviceFilter.service": {
+ "location": "query",
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "[Optional] The maximum number of results to return per response.",
+ "format": "int32"
}
},
- "flatPath": "v1beta1/projects/{projectsId}/events",
- "path": "v1beta1/{+projectName}/events",
- "id": "clouderrorreporting.projects.events.list",
- "description": "Lists the specified events."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"report": {
- "response": {
- "$ref": "ReportErrorEventResponse"
+ "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"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "ReportErrorEventResponse"
+ },
"parameters": {
"projectName": {
"location": "path",
@@ -471,30 +481,20 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/events:report",
- "path": "v1beta1/{+projectName}/events:report",
- "id": "clouderrorreporting.projects.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"
+ ]
}
}
},
"groups": {
"methods": {
"get": {
+ "httpMethod": "GET",
"response": {
"$ref": "ErrorGroup"
},
"parameterOrder": [
"groupName"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"groupName": {
"required": true,
@@ -504,16 +504,15 @@
"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": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
- "path": "v1beta1/{+groupName}",
"id": "clouderrorreporting.projects.groups.get",
+ "path": "v1beta1/{+groupName}",
"description": "Get the specified group."
},
"update": {
- "request": {
- "$ref": "ErrorGroup"
- },
- "description": "Replace the data for the specified group.\nFails if the group does not exist.",
"response": {
"$ref": "ErrorGroup"
},
@@ -521,6 +520,9 @@
"name"
],
"httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
"required": true,
@@ -530,12 +532,13 @@
"description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
"path": "v1beta1/{+name}",
- "id": "clouderrorreporting.projects.groups.update"
+ "id": "clouderrorreporting.projects.groups.update",
+ "description": "Replace the data for the specified group.\nFails if the group does not exist.",
+ "request": {
+ "$ref": "ErrorGroup"
+ }
}
}
},
@@ -549,6 +552,9 @@
"projectName"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"timeRange.period": {
"location": "query",
@@ -574,10 +580,10 @@
"type": "string"
},
"groupId": {
- "type": "string",
- "repeated": true,
"location": "query",
- "description": "[Optional] List all \u003ccode\u003eErrorGroupStats\u003c/code\u003e with these IDs."
+ "description": "[Optional] List all \u003ccode\u003eErrorGroupStats\u003c/code\u003e with these IDs.",
+ "type": "string",
+ "repeated": true
},
"serviceFilter.service": {
"type": "string",
@@ -590,7 +596,13 @@
"description": "[Optional] The maximum number of results to return per response.\nDefault is 20.",
"format": "int32"
},
+ "serviceFilter.version": {
+ "type": "string",
+ "location": "query",
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version)."
+ },
"order": {
+ "type": "string",
"location": "query",
"enum": [
"GROUP_ORDER_UNSPECIFIED",
@@ -599,24 +611,18 @@
"CREATED_DESC",
"AFFECTED_USERS_DESC"
],
- "description": "[Optional] The sort order in which the results are returned.\nDefault is `COUNT_DESC`.",
- "type": "string"
- },
- "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"
+ "description": "[Optional] The sort order in which the results are returned.\nDefault is `COUNT_DESC`."
},
"serviceFilter.resourceType": {
+ "type": "string",
"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"
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type)."
},
"alignmentTime": {
+ "type": "string",
"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"
+ "format": "google-datetime"
},
"projectName": {
"required": true,
@@ -637,9 +643,6 @@
"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."
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1beta1/projects/{projectsId}/groupStats",
"path": "v1beta1/{+projectName}/groupStats",
"id": "clouderrorreporting.projects.groupStats.list",
@@ -651,66 +654,6 @@
}
},
"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": {
- "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": {
- "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."
- },
- "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": {
- "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": {
"type": "string",
"enumDescriptions": [
@@ -728,14 +671,74 @@
]
},
"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": {
+ "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": {
+ "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": {
"type": "string",
"location": "query",
- "description": "OAuth access token."
+ "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."
+ },
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
+ },
+ "$.xgafv": {
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
}
},
"version": "v1beta1",
@@ -743,8 +746,5 @@
"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": "",
- "id": "clouderrorreporting:v1beta1",
- "revision": "20171208",
- "documentationLink": "https://cloud.google.com/error-reporting/"
+ "basePath": ""
}
diff --git a/cloudfunctions/v1/cloudfunctions-api.json b/cloudfunctions/v1/cloudfunctions-api.json
index 6607fbe..1bf3c07 100644
--- a/cloudfunctions/v1/cloudfunctions-api.json
+++ b/cloudfunctions/v1/cloudfunctions-api.json
@@ -1,160 +1,74 @@
{
- "id": "cloudfunctions:v1",
+ "basePath": "",
"documentationLink": "https://cloud.google.com/functions",
+ "id": "cloudfunctions:v1",
"revision": "20171206",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "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 `GenerateSourceUploadUrl` method.",
- "type": "object",
- "properties": {},
- "id": "GenerateUploadUrlRequest"
- },
- "ListOperationsResponse": {
- "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.",
- "type": "object"
- },
- "GenerateUploadUrlResponse": {
- "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",
- "description": "Response of `GenerateSourceUploadUrl` method."
- },
- "ListFunctionsResponse": {
- "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.v1.ListFunctionsRequest\nto get more functions.",
- "type": "string"
- },
- "functions": {
- "description": "The functions that match the request.",
- "type": "array",
- "items": {
- "$ref": "CloudFunction"
- }
- }
- },
- "id": "ListFunctionsResponse",
- "description": "Response for the `ListFunctions` method."
- },
"CallFunctionResponse": {
+ "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"
+ "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": {
- "type": "string",
- "description": "Either system or user-function generated error. Set if execution\nwas not successful."
+ "description": "Either system or user-function generated error. Set if execution\nwas not successful.",
+ "type": "string"
}
},
"id": "CallFunctionResponse",
- "description": "Response of `CallFunction` method.",
- "type": "object"
+ "description": "Response of `CallFunction` method."
},
"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"
- }
+ },
+ "description": "A list of locations that matches the specified filter in the request."
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
"id": "ListLocationsResponse"
},
"EventTrigger": {
- "description": "Describes EventTrigger, used to request events be sent from another\nservice.",
"type": "object",
"properties": {
- "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 1. namespace: For example, `cloud.storage` and\n `google.firebase.analytics`.\n 2. resource type: The type of resource on which event occurs. For\n example, the Google Cloud Storage API includes the type `object`.\n 3. 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"
- },
"resource": {
- "description": "Required. The resource(s) from which to observe events, for example,\n`projects/_/buckets/myBucket`.\n\nNot all syntactically correct values are accepted by all services. For\nexample:\n\n1. The authorization model must support it. Google Cloud Functions\n only allows EventTriggers to be deployed that observe resources in the\n same project as the `CloudFunction`.\n2. The resource type must match the pattern expected for an\n `event_type`. For example, an `EventTrigger` that has an\n `event_type` of \"google.pubsub.topic.publish\" should have a resource\n that matches Google Cloud Pub/Sub topics.\n\nAdditionally, some services may support short names when creating an\n`EventTrigger`. These will always be returned in the normalized \"long\"\nformat.\n\nSee each *service's* documentation for supported formats.",
- "type": "string"
+ "type": "string",
+ "description": "Required. The resource(s) from which to observe events, for example,\n`projects/_/buckets/myBucket`.\n\nNot all syntactically correct values are accepted by all services. For\nexample:\n\n1. The authorization model must support it. Google Cloud Functions\n only allows EventTriggers to be deployed that observe resources in the\n same project as the `CloudFunction`.\n2. The resource type must match the pattern expected for an\n `event_type`. For example, an `EventTrigger` that has an\n `event_type` of \"google.pubsub.topic.publish\" should have a resource\n that matches Google Cloud Pub/Sub topics.\n\nAdditionally, some services may support short names when creating an\n`EventTrigger`. These will always be returned in the normalized \"long\"\nformat.\n\nSee each *service's* documentation for supported formats."
},
"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"
+ "$ref": "FailurePolicy",
+ "description": "Specifies policy for failed executions."
+ },
+ "eventType": {
+ "type": "string",
+ "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 1. namespace: For example, `cloud.storage` and\n `google.firebase.analytics`.\n 2. resource type: The type of resource on which event occurs. For\n example, the Google Cloud Storage API includes the type `object`.\n 3. action: The action that generates the event. For example, action for\n a Google Cloud Storage Object is 'change'.\nThese parts are lower case."
}
},
- "id": "EventTrigger"
+ "id": "EventTrigger",
+ "description": "Describes EventTrigger, used to request events be sent from another\nservice."
},
"OperationMetadataV1": {
- "description": "Metadata describing an Operation",
"type": "object",
"properties": {
- "type": {
- "description": "Type of operation.",
- "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"
- ]
- },
"updateTime": {
"description": "The last update timestamp of the operation.",
"format": "google-datetime",
@@ -166,46 +80,72 @@
},
"request": {
"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."
},
"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": "string"
+ "format": "int64"
+ },
+ "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."
+ ]
}
},
- "id": "OperationMetadataV1"
+ "id": "OperationMetadataV1",
+ "description": "Metadata describing an Operation"
},
"GenerateDownloadUrlRequest": {
- "description": "Request of `GenerateDownloadUrl` method.",
"type": "object",
"properties": {
"versionId": {
+ "type": "string",
"description": "The optional version of function. If not set, default, current version\nis used.",
- "format": "uint64",
- "type": "string"
+ "format": "uint64"
}
},
- "id": "GenerateDownloadUrlRequest"
+ "id": "GenerateDownloadUrlRequest",
+ "description": "Request of `GenerateDownloadUrl` method."
},
"FailurePolicy": {
- "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).",
"type": "object",
"properties": {
"retry": {
- "description": "If specified, then the function will be retried in case of a failure.",
- "$ref": "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)."
},
"Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
+ "metadata": {
+ "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"
@@ -219,30 +159,27 @@
"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",
"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",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
+ "id": "Operation"
},
"OperationMetadataV1Beta2": {
+ "type": "object",
"properties": {
+ "updateTime": {
+ "type": "string",
+ "description": "The last update timestamp of the operation.",
+ "format": "google-datetime"
+ },
"target": {
- "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
- "type": "string"
+ "type": "string",
+ "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1"
},
"request": {
"additionalProperties": {
@@ -253,12 +190,11 @@
"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": "string"
+ "format": "int64"
},
"type": {
- "description": "Type of operation.",
"type": "string",
"enumDescriptions": [
"Unknown operation type.",
@@ -271,17 +207,12 @@
"CREATE_FUNCTION",
"UPDATE_FUNCTION",
"DELETE_FUNCTION"
- ]
- },
- "updateTime": {
- "description": "The last update timestamp of the operation.",
- "format": "google-datetime",
- "type": "string"
+ ],
+ "description": "Type of operation."
}
},
"id": "OperationMetadataV1Beta2",
- "description": "Metadata describing an Operation",
- "type": "object"
+ "description": "Metadata describing an Operation"
},
"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.",
@@ -293,19 +224,19 @@
"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": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ }
+ },
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
}
},
"id": "Status"
@@ -322,56 +253,30 @@
"id": "CallFunctionRequest"
},
"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.",
- "type": "string"
- },
"url": {
"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"
+ },
+ "deployedUrl": {
+ "type": "string",
+ "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."
}
},
- "id": "SourceRepository"
+ "id": "SourceRepository",
+ "description": "Describes SourceRepository, used to represent parameters related to\nsource repository where a function is hosted."
},
"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": {
- "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`.",
+ "sourceUploadUrl": {
+ "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1.GenerateUploadUrl",
"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": {
- "type": "string",
- "description": "User-provided description of a function."
- },
- "timeout": {
- "type": "string",
- "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"
+ "eventTrigger": {
+ "$ref": "EventTrigger",
+ "description": "A source that fires events in response to a condition in another service."
},
"status": {
"enum": [
@@ -393,12 +298,9 @@
"Function deployment failed and the function serving state is undefined.\nThe function should be updated or deleted to move it out of this state."
]
},
- "eventTrigger": {
- "description": "A source that fires events in response to a condition in another service.",
- "$ref": "EventTrigger"
- },
- "sourceUploadUrl": {
- "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1.GenerateUploadUrl",
+ "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"
},
"availableMemoryMb": {
@@ -416,32 +318,63 @@
"type": "string"
},
"sourceArchiveUrl": {
- "description": "The Google Cloud Storage URL, starting with gs://, pointing to the zip\narchive which contains the function.",
- "type": "string"
+ "type": "string",
+ "description": "The Google Cloud Storage URL, starting with gs://, pointing to the zip\narchive which contains the function."
},
"sourceRepository": {
"$ref": "SourceRepository",
"description": "**Beta Feature**\n\nThe source repository where a function is hosted."
+ },
+ "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": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels associated with this Cloud Function."
+ },
+ "updateTime": {
+ "type": "string",
+ "description": "Output only. The last update timestamp of a Cloud Function.",
+ "format": "google-datetime"
+ },
+ "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"
+ "id": "CloudFunction",
+ "description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations."
},
"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"
+ "type": "string",
+ "description": "Output only. The deployed url for the function."
}
},
- "id": "HttpsTrigger"
+ "id": "HttpsTrigger",
+ "description": "Describes HttpsTrigger, could be used to connect web hooks to function."
},
"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.\nFor example: `\"projects/example-project/locations/us-east1\"`",
- "type": "string"
+ "type": "string",
+ "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`"
},
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
@@ -449,29 +382,97 @@
},
"metadata": {
"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."
},
"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\"}",
- "type": "object"
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}"
}
},
- "id": "Location",
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object"
+ "id": "Location"
+ },
+ "GenerateDownloadUrlResponse": {
+ "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",
+ "description": "Response of `GenerateDownloadUrl` method."
+ },
+ "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 `GenerateSourceUploadUrl` 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 `GenerateSourceUploadUrl` 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": {
+ "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.v1.ListFunctionsRequest\nto get more functions.",
+ "type": "string"
+ },
+ "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"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"canonicalName": "Cloud Functions",
"auth": {
@@ -491,22 +492,85 @@
"title": "Google Cloud Functions API",
"ownerName": "Google",
"resources": {
+ "operations": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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."
+ },
+ "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": {
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "cloudfunctions.operations.get",
+ "path": "v1/{+name}"
+ }
+ }
+ },
"projects": {
"resources": {
"locations": {
"methods": {
"list": {
"description": "Lists information about the supported locations for this service.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListLocationsResponse"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"filter": {
"type": "string",
@@ -514,11 +578,11 @@
"description": "The standard list filter."
},
"name": {
+ "required": true,
+ "type": "string",
"pattern": "^projects/[^/]+$",
"location": "path",
- "description": "The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string"
+ "description": "The resource that owns the locations collection, if applicable."
},
"pageToken": {
"location": "query",
@@ -526,104 +590,23 @@
"type": "string"
},
"pageSize": {
+ "type": "integer",
"location": "query",
"description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1/projects/{projectsId}/locations",
- "path": "v1/{+name}/locations",
- "id": "cloudfunctions.projects.locations.list"
+ "id": "cloudfunctions.projects.locations.list",
+ "path": "v1/{+name}/locations"
}
},
"resources": {
"functions": {
"methods": {
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "path": "v1/{+name}",
- "id": "cloudfunctions.projects.locations.functions.patch",
- "description": "Updates existing function.",
- "request": {
- "$ref": "CloudFunction"
- }
- },
- "get": {
- "path": "v1/{+name}",
- "id": "cloudfunctions.projects.locations.functions.get",
- "description": "Returns a function with the given name from the requested project.",
- "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}"
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "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}",
- "id": "cloudfunctions.projects.locations.functions.delete",
- "path": "v1/{+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."
- },
"list": {
"response": {
"$ref": "ListFunctionsResponse"
@@ -636,23 +619,23 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "parent": {
- "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"
},
"pageSize": {
- "description": "Maximum number of functions to return per call.",
- "format": "int32",
"type": "integer",
- "location": "query"
+ "location": "query",
+ "description": "Maximum number of functions to return per call.",
+ "format": "int32"
+ },
+ "parent": {
+ "required": true,
+ "type": "string",
+ "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."
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions",
@@ -661,66 +644,62 @@
"description": "Returns a list of functions that belong to the requested project."
},
"call": {
- "id": "cloudfunctions.projects.locations.functions.call",
+ "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"
},
- "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "CallFunctionResponse"
},
- "parameters": {
- "name": {
- "description": "The name of the function to be called.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path"
- }
- },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call"
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path",
+ "description": "The name of the function to be called."
+ }
+ }
},
"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"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"location"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
"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/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions",
- "path": "v1/{+location}/functions",
- "id": "cloudfunctions.projects.locations.functions.create"
+ "id": "cloudfunctions.projects.locations.functions.create",
+ "path": "v1/{+location}/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.",
- "request": {
- "$ref": "GenerateUploadUrlRequest"
- },
"response": {
"$ref": "GenerateUploadUrlResponse"
},
@@ -733,25 +712,22 @@
],
"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/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl",
"path": "v1/{+parent}/functions:generateUploadUrl",
- "id": "cloudfunctions.projects.locations.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.",
+ "request": {
+ "$ref": "GenerateUploadUrlRequest"
+ }
},
"generateDownloadUrl": {
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}: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"
},
@@ -764,136 +740,167 @@
],
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
"location": "path",
"description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
}
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}: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"
}
+ },
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path",
+ "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`"
+ },
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask"
+ }
+ },
+ "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."
+ },
+ "get": {
+ "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.",
+ "response": {
+ "$ref": "CloudFunction"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path",
+ "description": "The name of the function which should be deleted."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "id": "cloudfunctions.projects.locations.functions.delete",
+ "path": "v1/{+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."
}
}
}
}
}
}
- },
- "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.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [],
- "parameters": {
- "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"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/operations",
- "id": "cloudfunctions.operations.list",
- "path": "v1/operations"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "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"
- ],
- "flatPath": "v1/operations/{operationsId}",
- "id": "cloudfunctions.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": {
- "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.",
+ "access_token": {
"type": "string",
- "location": "query"
+ "location": "query",
+ "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": {
- "description": "Pretty-print response.",
"type": "boolean",
"default": "true",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Pretty-print response."
},
"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": {
- "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"
+ "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"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
},
"$.xgafv": {
+ "location": "query",
"enum": [
"1",
"2"
@@ -903,8 +910,12 @@
"enumDescriptions": [
"v1 error format",
"v2 error format"
- ],
- "location": "query"
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
"type": "string",
@@ -921,22 +932,11 @@
"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://cloudfunctions.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "API for managing lightweight user-provided functions executed in response to events.",
"servicePath": "",
- "basePath": ""
+ "description": "API for managing lightweight user-provided functions executed in response to events.",
+ "kind": "discovery#restDescription"
}
diff --git a/cloudfunctions/v1beta2/cloudfunctions-api.json b/cloudfunctions/v1beta2/cloudfunctions-api.json
index 9c0b542..007cdc2 100644
--- a/cloudfunctions/v1beta2/cloudfunctions-api.json
+++ b/cloudfunctions/v1beta2/cloudfunctions-api.json
@@ -1,26 +1,106 @@
{
- "version": "v1beta2",
- "baseUrl": "https://cloudfunctions.googleapis.com/",
- "servicePath": "",
- "description": "API for managing lightweight user-provided functions executed in response to events.",
- "kind": "discovery#restDescription",
- "basePath": "",
- "id": "cloudfunctions:v1beta2",
- "documentationLink": "https://cloud.google.com/functions",
- "revision": "20171206",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "HTTPSTrigger": {
- "description": "Describes HTTPSTrigger, could be used to connect web hooks to function.",
+ "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": {
+ "properties": {
+ "functions": {
+ "description": "The functions that match the request.",
+ "type": "array",
+ "items": {
+ "$ref": "CloudFunction"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "ListFunctionsResponse",
+ "description": "Response for the `ListFunctions` method.",
+ "type": "object"
+ },
+ "CallFunctionResponse": {
+ "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"
+ },
+ "error": {
+ "description": "Either system or user-function generated error. Set if execution\nwas not successful.",
+ "type": "string"
+ }
+ },
+ "id": "CallFunctionResponse"
+ },
+ "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"
+ },
+ "EventTrigger": {
+ "description": "Describes EventTrigger, used to request events be sent from another\nservice.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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\n Handle an object changing in Google Cloud Storage\n `providers/cloud.storage/eventTypes/object.change`\n\n Handle a write to the Firebase Realtime Database\n `providers/google.firebase.database/eventTypes/ref.write`",
+ "type": "string"
+ }
+ },
+ "id": "EventTrigger"
+ },
+ "HTTPSTrigger": {
+ "properties": {
"url": {
"description": "Output only. The deployed url for the function.",
"type": "string"
}
},
- "id": "HTTPSTrigger"
+ "id": "HTTPSTrigger",
+ "description": "Describes HTTPSTrigger, could be used to connect web hooks to function.",
+ "type": "object"
},
"FailurePolicy": {
"description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).",
@@ -46,6 +126,8 @@
"id": "GenerateDownloadUrlRequest"
},
"OperationMetadataV1": {
+ "description": "Metadata describing an Operation",
+ "type": "object",
"properties": {
"updateTime": {
"description": "The last update timestamp of the operation.",
@@ -70,6 +152,12 @@
"type": "string"
},
"type": {
+ "enumDescriptions": [
+ "Unknown operation type.",
+ "Triggered by CreateFunction call",
+ "Triggered by UpdateFunction call",
+ "Triggered by DeleteFunction call."
+ ],
"enum": [
"OPERATION_UNSPECIFIED",
"CREATE_FUNCTION",
@@ -77,25 +165,13 @@
"DELETE_FUNCTION"
],
"description": "Type of operation.",
- "type": "string",
- "enumDescriptions": [
- "Unknown operation type.",
- "Triggered by CreateFunction call",
- "Triggered by UpdateFunction call",
- "Triggered by DeleteFunction call."
- ]
+ "type": "string"
}
},
- "id": "OperationMetadataV1",
- "description": "Metadata describing an Operation",
- "type": "object"
+ "id": "OperationMetadataV1"
},
"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.",
@@ -109,8 +185,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": {
@@ -119,6 +195,10 @@
},
"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",
@@ -171,9 +251,12 @@
"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": {
+ "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"
@@ -188,14 +271,11 @@
},
"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.",
+ "type": "object"
},
"CallFunctionRequest": {
"properties": {
@@ -209,19 +289,9 @@
"type": "object"
},
"SourceRepository": {
+ "description": "Describes the location of the function source in a remote repository.",
+ "type": "object",
"properties": {
- "branch": {
- "description": "The name of the branch from which the function should be fetched.",
- "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"
- },
- "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"
- },
"revision": {
"description": "The id of the revision that captures the state of the repository from\nwhich the function should be fetched.",
"type": "string"
@@ -233,11 +303,21 @@
"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"
+ },
+ "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"
+ },
+ "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"
}
},
- "id": "SourceRepository",
- "description": "Describes the location of the function source in a remote repository.",
- "type": "object"
+ "id": "SourceRepository"
},
"CloudFunction": {
"properties": {
@@ -247,8 +327,6 @@
"type": "string"
},
"status": {
- "description": "Output only. Status of the function deployment.",
- "type": "string",
"enumDescriptions": [
"Status not specified.",
"Successfully deployed.",
@@ -262,7 +340,9 @@
"FAILED",
"DEPLOYING",
"DELETING"
- ]
+ ],
+ "description": "Output only. Status of the function deployment.",
+ "type": "string"
},
"eventTrigger": {
"description": "A source that fires events in response to a condition in another service.",
@@ -332,20 +412,7 @@
"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\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"
@@ -357,9 +424,22 @@
},
"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"
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
+ "type": "string"
}
},
- "id": "Location"
+ "id": "Location",
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object"
},
"GenerateDownloadUrlResponse": {
"description": "Response of `GenerateDownloadUrl` method.",
@@ -373,10 +453,10 @@
"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": {
"properties": {},
@@ -388,114 +468,25 @@
"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"
- },
- "CallFunctionResponse": {
- "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"
- },
- "error": {
- "description": "Either system or user-function generated error. Set if execution\nwas not successful.",
- "type": "string"
- }
- },
- "id": "CallFunctionResponse"
- },
- "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"
- },
- "EventTrigger": {
- "description": "Describes EventTrigger, used to request events be sent from another\nservice.",
- "type": "object",
- "properties": {
- "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."
- },
- "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\n Handle an object changing in Google Cloud Storage\n `providers/cloud.storage/eventTypes/object.change`\n\n Handle 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"
- }
- },
- "id": "EventTrigger"
+ "id": "ListOperationsResponse"
}
},
"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 Functions",
"auth": {
@@ -515,81 +506,11 @@
"title": "Google Cloud Functions API",
"ownerName": "Google",
"resources": {
- "operations": {
- "methods": {
- "list": {
- "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"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/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": "^operations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/operations/{operationsId}",
- "path": "v1beta2/{+name}",
- "id": "cloudfunctions.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."
- }
- }
- },
"projects": {
"resources": {
"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"
},
@@ -601,35 +522,187 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
"location": "query"
},
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
"name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
"description": "The resource that owns the locations collection, if applicable.",
"required": true,
- "type": "string"
+ "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"
}
- }
+ },
+ "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": {
+ "response": {
+ "$ref": "ListFunctionsResponse"
+ },
+ "parameterOrder": [
+ "location"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "location": {
+ "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"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of functions to return per call.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
+ "path": "v1beta2/{+location}/functions",
+ "id": "cloudfunctions.projects.locations.functions.list",
+ "description": "Returns a list of functions that belong to the requested project."
+ },
+ "create": {
+ "path": "v1beta2/{+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": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions"
+ },
+ "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"
+ },
+ "response": {
+ "$ref": "CallFunctionResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the function to be called.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call"
+ },
+ "generateUploadUrl": {
+ "response": {
+ "$ref": "GenerateUploadUrlResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "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.",
+ "request": {
+ "$ref": "GenerateUploadUrlRequest"
+ }
+ },
+ "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": {
"description": "Returns a function with the given name from the requested project.",
"httpMethod": "GET",
@@ -641,11 +714,11 @@
},
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path",
"description": "The name of the function which details should be obtained.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -696,199 +769,102 @@
],
"parameters": {
"name": {
- "location": "path",
"description": "The name of the function which should be deleted.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
- "path": "v1beta2/{+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": {
- "path": "v1beta2/{+location}/functions",
- "id": "cloudfunctions.projects.locations.functions.list",
- "description": "Returns a list of functions that belong to the requested project.",
- "response": {
- "$ref": "ListFunctionsResponse"
- },
- "parameterOrder": [
- "location"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Maximum number of functions to return per call.",
- "format": "int32",
- "type": "integer"
- },
- "location": {
- "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/[^/]+$",
- "location": "path"
- },
- "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"
- },
- "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": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
- "path": "v1beta2/{+location}/functions",
- "id": "cloudfunctions.projects.locations.functions.create"
- },
- "call": {
- "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"
- },
- "response": {
- "$ref": "CallFunctionResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the function to be called.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
- }
- }
- },
- "generateUploadUrl": {
- "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": "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.",
- "request": {
- "$ref": "GenerateUploadUrlRequest"
- }
- },
- "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"
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "path": "v1beta2/{+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."
}
}
}
}
}
}
+ },
+ "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": {
+ "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": {
+ "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/operations",
+ "path": "v1beta2/operations",
+ "id": "cloudfunctions.operations.list"
+ },
+ "get": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta2/operations/{operationsId}",
+ "path": "v1beta2/{+name}",
+ "id": "cloudfunctions.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": {
- "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"
+ "default": "true",
+ "location": "query"
},
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"bearer_token": {
"description": "OAuth bearer token.",
@@ -907,9 +883,9 @@
"location": "query"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"uploadType": {
"location": "query",
@@ -935,6 +911,8 @@
"type": "string"
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -946,9 +924,31 @@
"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": "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"
+ },
+ "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": "v1beta2",
+ "baseUrl": "https://cloudfunctions.googleapis.com/",
+ "servicePath": "",
+ "description": "API for managing lightweight user-provided functions executed in response to events.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "id": "cloudfunctions:v1beta2",
+ "documentationLink": "https://cloud.google.com/functions",
+ "revision": "20171206"
}
diff --git a/cloudiot/v1/cloudiot-api.json b/cloudiot/v1/cloudiot-api.json
index 567ea2f..965838b 100644
--- a/cloudiot/v1/cloudiot-api.json
+++ b/cloudiot/v1/cloudiot-api.json
@@ -1,33 +1,11 @@
{
- "id": "cloudiot:v1",
- "documentationLink": "https://cloud.google.com/iot",
- "revision": "20171205",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"Device": {
+ "description": "The device resource.",
+ "type": "object",
"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",
- "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",
@@ -53,8 +31,8 @@
"type": "string"
},
"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."
+ "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.",
+ "$ref": "Status"
},
"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.",
@@ -62,12 +40,16 @@
"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"
+ "$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"
+ "$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": {
+ "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.",
@@ -76,14 +58,29 @@
"$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.",
+ "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",
"type": "string"
}
},
- "id": "Device",
- "description": "The device resource.",
- "type": "object"
+ "id": "Device"
},
"ListDeviceConfigVersionsResponse": {
"description": "Response for `ListDeviceConfigVersions`.",
@@ -100,17 +97,7 @@
"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"
@@ -128,24 +115,21 @@
"description": "The time the certificate becomes invalid.",
"format": "google-datetime",
"type": "string"
- }
- },
- "id": "X509CertificateDetails"
- },
- "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`.",
+ },
+ "subject": {
+ "description": "The entity the certificate and public key belong to.",
+ "type": "string"
+ },
+ "issuer": {
+ "description": "The entity that signed the certificate.",
"type": "string"
}
},
- "id": "EventNotificationConfig"
+ "id": "X509CertificateDetails",
+ "description": "Details of an X.509 certificate. For informational purposes only.",
+ "type": "object"
},
"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.",
@@ -157,7 +141,20 @@
"$ref": "Policy"
}
},
- "id": "SetIamPolicyRequest"
+ "id": "SetIamPolicyRequest",
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object"
+ },
+ "EventNotificationConfig": {
+ "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"
},
"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 `{}`.",
@@ -166,8 +163,6 @@
"id": "Empty"
},
"PublicKeyCredential": {
- "description": "A public key format and data.",
- "type": "object",
"properties": {
"key": {
"description": "The key data.",
@@ -192,55 +187,55 @@
"type": "string"
}
},
- "id": "PublicKeyCredential"
+ "id": "PublicKeyCredential",
+ "description": "A public key format and data.",
+ "type": "object"
},
"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."
+ "description": "[Output only] The certificate details. Used only for X.509 certificates.",
+ "$ref": "X509CertificateDetails"
},
"format": {
- "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-----`."
- ],
"enum": [
"UNSPECIFIED_PUBLIC_KEY_CERTIFICATE_FORMAT",
"X509_CERTIFICATE_PEM"
],
"description": "The certificate format.",
- "type": "string"
+ "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-----`."
+ ]
}
},
- "id": "PublicKeyCertificate"
+ "id": "PublicKeyCertificate",
+ "description": "A public key certificate format and data.",
+ "type": "object"
},
"DeviceState": {
"description": "The device state, as reported by the device.",
"type": "object",
"properties": {
- "updateTime": {
- "description": "[Output only] The time at which this state version was updated in Cloud\nIoT Core.",
- "format": "google-datetime",
- "type": "string"
- },
"binaryData": {
"description": "The device state data.",
"format": "byte",
"type": "string"
+ },
+ "updateTime": {
+ "description": "[Output only] The time at which this state version was updated in Cloud\nIoT Core.",
+ "format": "google-datetime",
+ "type": "string"
}
},
"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": {
"description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
@@ -250,8 +245,6 @@
}
},
"logType": {
- "description": "The log type that this config enables.",
- "type": "string",
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
@@ -263,25 +256,16 @@
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
- ]
- }
- },
- "id": "AuditLogConfig"
- },
- "StateNotificationConfig": {
- "description": "The configuration for notification of new states received from the device.",
- "type": "object",
- "properties": {
- "pubsubTopicName": {
- "description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.",
+ ],
+ "description": "The log type that this config enables.",
"type": "string"
}
},
- "id": "StateNotificationConfig"
+ "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).",
@@ -291,23 +275,28 @@
}
}
},
- "id": "TestIamPermissionsRequest"
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object"
},
- "RegistryCredential": {
- "description": "A server-stored registry credential used to validate device credentials.",
- "type": "object",
+ "StateNotificationConfig": {
"properties": {
- "publicKeyCertificate": {
- "$ref": "PublicKeyCertificate",
- "description": "A public key certificate used to verify the device credentials."
+ "pubsubTopicName": {
+ "description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.",
+ "type": "string"
}
},
- "id": "RegistryCredential"
+ "id": "StateNotificationConfig",
+ "description": "The configuration for notification of new states received from the device.",
+ "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",
@@ -331,37 +320,41 @@
"items": {
"$ref": "Binding"
}
- },
- "iamOwned": {
- "type": "boolean"
}
},
"id": "Policy"
},
+ "RegistryCredential": {
+ "properties": {
+ "publicKeyCertificate": {
+ "description": "A public key certificate used to verify the device credentials.",
+ "$ref": "PublicKeyCertificate"
+ }
+ },
+ "id": "RegistryCredential",
+ "description": "A server-stored registry credential used to validate device credentials.",
+ "type": "object"
+ },
"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"
},
"DeviceRegistry": {
"properties": {
- "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."
- },
"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.",
"type": "array",
@@ -391,6 +384,10 @@
"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."
}
},
"id": "DeviceRegistry",
@@ -401,30 +398,45 @@
"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"
}
+ },
+ "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"
}
},
"id": "ListDevicesResponse"
},
+ "HttpConfig": {
+ "description": "The configuration of the HTTP bridge for a device registry.",
+ "type": "object",
+ "properties": {
+ "httpEnabledState": {
+ "enum": [
+ "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",
+ "enumDescriptions": [
+ "No HTTP state specified. If not specified, DeviceService will be\nenabled by default.",
+ "Enables DeviceService (HTTP) service for the registry.",
+ "Disables DeviceService (HTTP) service for the registry."
+ ]
+ }
+ },
+ "id": "HttpConfig"
+ },
"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"
@@ -435,31 +447,16 @@
"items": {
"$ref": "AuditLogConfig"
}
+ },
+ "exemptedMembers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"id": "AuditConfig"
},
- "HttpConfig": {
- "properties": {
- "httpEnabledState": {
- "enumDescriptions": [
- "No HTTP state specified. If not specified, DeviceService will be\nenabled by default.",
- "Enables DeviceService (HTTP) service for the registry.",
- "Disables DeviceService (HTTP) service for the registry."
- ],
- "enum": [
- "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",
- "description": "The configuration of the HTTP bridge for a device registry.",
- "type": "object"
- },
"DeviceCredential": {
"description": "A server-stored device credential used for authentication.",
"type": "object",
@@ -477,8 +474,6 @@
"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.",
@@ -501,15 +496,15 @@
"type": "string"
}
},
- "id": "DeviceConfig"
+ "id": "DeviceConfig",
+ "description": "The device configuration. Eventually delivered to devices.",
+ "type": "object"
},
"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.",
- "type": "string",
"enumDescriptions": [
"No MQTT state specified. If not specified, MQTT will be enabled by default.",
"Enables a MQTT connection.",
@@ -519,14 +514,14 @@
"MQTT_STATE_UNSPECIFIED",
"MQTT_ENABLED",
"MQTT_DISABLED"
- ]
+ ],
+ "description": "If enabled, allows connections using the MQTT protocol. Otherwise, MQTT\nconnections to this registry will fail.",
+ "type": "string"
}
},
"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": {
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
@@ -549,13 +544,15 @@
"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"
},
"Binding": {
"properties": {
"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."
+ "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",
@@ -574,17 +571,7 @@
"type": "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": {
- "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"
@@ -592,9 +579,19 @@
"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"
+ },
+ "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"
}
},
- "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\"",
+ "type": "object"
},
"ModifyCloudToDeviceConfigRequest": {
"description": "Request for `ModifyCloudToDeviceConfig`.",
@@ -614,8 +611,6 @@
"id": "ModifyCloudToDeviceConfigRequest"
},
"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.",
@@ -625,17 +620,11 @@
}
}
},
- "id": "ListDeviceStatesResponse"
- },
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
+ "id": "ListDeviceStatesResponse",
+ "description": "Response for `ListDeviceStates`.",
+ "type": "object"
},
"TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
@@ -645,23 +634,31 @@
}
}
},
- "id": "TestIamPermissionsResponse"
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object"
+ },
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
}
},
+ "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 Iot",
"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/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"
}
}
}
@@ -680,49 +677,21 @@
"resources": {
"registries": {
"methods": {
- "get": {
- "response": {
- "$ref": "DeviceRegistry"
+ "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": [
- "name"
+ "resource"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "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/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
- "path": "v1/{+name}",
- "id": "cloudiot.projects.locations.registries.get",
- "description": "Gets a device registry configuration."
- },
- "patch": {
"response": {
- "$ref": "DeviceRegistry"
+ "$ref": "TestIamPermissionsResponse"
},
- "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`, `http_config`,\n`mqtt_config`, and `state_notification_config`.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "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/[^/]+/locations/[^/]+/registries/[^/]+$",
@@ -733,17 +702,76 @@
"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",
- "request": {
- "$ref": "DeviceRegistry"
- },
- "description": "Updates a device registry configuration."
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions",
+ "id": "cloudiot.projects.locations.registries.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions"
},
- "testIamPermissions": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
"response": {
- "$ref": "TestIamPermissionsResponse"
+ "$ref": "Empty"
+ },
+ "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": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
+ "id": "cloudiot.projects.locations.registries.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes a device registry configuration."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListDeviceRegistriesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "parent": {
+ "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"
+ },
+ "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"
+ },
+ "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"
+ }
+ },
+ "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"
@@ -755,96 +783,29 @@
],
"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/[^/]+/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.",
+ "required": true,
+ "type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}: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.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "cloudiot.projects.locations.registries.setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"request": {
- "$ref": "TestIamPermissionsRequest"
+ "$ref": "SetIamPolicyRequest"
}
},
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "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"
- }
- },
- "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.delete",
- "description": "Deletes a device registry configuration."
- },
- "list": {
- "response": {
- "$ref": "ListDeviceRegistriesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "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"
- },
- "pageToken": {
- "location": "query",
- "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"
- },
- "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"
- }
- },
- "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."
- },
"create": {
- "description": "Creates a device registry that contains devices.",
- "request": {
- "$ref": "DeviceRegistry"
- },
- "response": {
- "$ref": "DeviceRegistry"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "DeviceRegistry"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
@@ -859,10 +820,14 @@
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries",
+ "id": "cloudiot.projects.locations.registries.create",
"path": "v1/{+parent}/registries",
- "id": "cloudiot.projects.locations.registries.create"
+ "description": "Creates a device registry that contains devices.",
+ "request": {
+ "$ref": "DeviceRegistry"
+ }
},
- "setIamPolicy": {
+ "getIamPolicy": {
"response": {
"$ref": "Policy"
},
@@ -874,7 +839,7 @@
"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.",
+ "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"
}
@@ -883,57 +848,302 @@
"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."
- },
- "getIamPolicy": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy",
"path": "v1/{+resource}:getIamPolicy",
"id": "cloudiot.projects.locations.registries.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.",
+ "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 a device registry configuration.",
"response": {
- "$ref": "Policy"
+ "$ref": "DeviceRegistry"
},
"parameterOrder": [
- "resource"
+ "name"
],
- "httpMethod": "POST",
+ "httpMethod": "GET",
+ "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.",
+ "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.get"
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "DeviceRegistry"
+ },
+ "parameters": {
+ "name": {
+ "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/[^/]+$",
"location": "path"
+ },
+ "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"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy"
+ "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."
}
},
"resources": {
"devices": {
+ "methods": {
+ "get": {
+ "id": "cloudiot.projects.locations.registries.devices.get",
+ "path": "v1/{+name}",
+ "description": "Gets details about a device.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Device"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}"
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Device"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "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}",
+ "request": {
+ "$ref": "Device"
+ },
+ "description": "Updates a device."
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
+ "path": "v1/{+name}",
+ "id": "cloudiot.projects.locations.registries.devices.delete",
+ "description": "Deletes a device."
+ },
+ "list": {
+ "id": "cloudiot.projects.locations.registries.devices.list",
+ "path": "v1/{+parent}/devices",
+ "description": "List devices in a device registry.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListDevicesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "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": {
+ "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": {
+ "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",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices"
+ },
+ "create": {
+ "response": {
+ "$ref": "Device"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "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": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
+ "path": "v1/{+parent}/devices",
+ "id": "cloudiot.projects.locations.registries.devices.create",
+ "request": {
+ "$ref": "Device"
+ },
+ "description": "Creates a device in a device registry."
+ },
+ "modifyCloudToDeviceConfig": {
+ "response": {
+ "$ref": "DeviceConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}: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"
+ }
+ }
+ },
"resources": {
"configVersions": {
"methods": {
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
"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}`.",
@@ -943,19 +1153,15 @@
"location": "path"
},
"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"
+ "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}/configVersions",
- "id": "cloudiot.projects.locations.registries.devices.configVersions.list",
"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)."
}
}
@@ -996,215 +1202,6 @@
}
}
}
- },
- "methods": {
- "delete": {
- "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",
- "description": "Deletes a device."
- },
- "list": {
- "description": "List devices in a device registry.",
- "response": {
- "$ref": "ListDevicesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "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"
- },
- "pageSize": {
- "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",
- "type": "integer"
- },
- "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": {
- "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,
- "location": "query"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
- "path": "v1/{+parent}/devices",
- "id": "cloudiot.projects.locations.registries.devices.list"
- },
- "create": {
- "request": {
- "$ref": "Device"
- },
- "description": "Creates a device in a device registry.",
- "response": {
- "$ref": "Device"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
- "path": "v1/{+parent}/devices",
- "id": "cloudiot.projects.locations.registries.devices.create"
- },
- "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"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig",
- "path": "v1/{+name}:modifyCloudToDeviceConfig",
- "id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig"
- },
- "patch": {
- "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"
- },
- "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": {
- "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"
- }
- }
- },
- "get": {
- "description": "Gets details about a device.",
- "response": {
- "$ref": "Device"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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/[^/]+$"
- },
- "fieldMask": {
- "location": "query",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "path": "v1/{+name}",
- "id": "cloudiot.projects.locations.registries.devices.get"
- }
}
}
}
@@ -1215,22 +1212,6 @@
}
},
"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": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -1248,22 +1229,22 @@
"type": "string"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "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",
@@ -1271,6 +1252,12 @@
"location": "query"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -1278,34 +1265,47 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
+ "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",
- "location": "query"
- },
- "access_token": {
- "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",
- "location": "query"
+ "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": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
}
},
"version": "v1",
"baseUrl": "https://cloudiot.googleapis.com/",
"servicePath": "",
- "kind": "discovery#restDescription",
"description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n",
- "basePath": ""
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "documentationLink": "https://cloud.google.com/iot",
+ "id": "cloudiot:v1",
+ "revision": "20171205"
}
diff --git a/cloudiot/v1beta1/cloudiot-api.json b/cloudiot/v1beta1/cloudiot-api.json
index 8ae9e21..0adcf2e 100644
--- a/cloudiot/v1beta1/cloudiot-api.json
+++ b/cloudiot/v1beta1/cloudiot-api.json
@@ -1,296 +1,17 @@
{
+ "version": "v1beta1",
+ "baseUrl": "https://cloudiot.googleapis.com/",
"servicePath": "",
- "description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n",
"kind": "discovery#restDescription",
+ "description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n",
"basePath": "",
- "id": "cloudiot:v1beta1",
- "documentationLink": "https://cloud.google.com/iot",
"revision": "20171205",
+ "documentationLink": "https://cloud.google.com/iot",
+ "id": "cloudiot:v1beta1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "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": {
- "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"
- },
- "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": "Policy"
- },
- "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"
- },
- "Device": {
- "properties": {
- "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"
- },
- "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"
- }
- },
- "id": "Device",
- "description": "The device resource.",
- "type": "object"
- },
- "DeviceRegistry": {
- "description": "A container for a group of devices.",
- "type": "object",
- "properties": {
- "eventNotificationConfig": {
- "$ref": "NotificationConfig",
- "description": "Configuration to notify events received from the device."
- },
- "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"
- }
- },
- "id": "DeviceRegistry"
- },
- "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.",
- "type": "array",
- "items": {
- "$ref": "DeviceConfig"
- }
- }
- },
- "id": "ListDeviceConfigVersionsResponse"
- },
- "ListDevicesResponse": {
- "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"
- }
- }
- },
- "id": "ListDevicesResponse",
- "description": "Response for `ListDevices`.",
- "type": "object"
- },
- "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"
- },
- "DeviceCredential": {
- "description": "A server-stored device credential used for authentication.",
- "type": "object",
- "properties": {
- "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": {
- "description": "A public key used to verify the signature of JSON Web Tokens (JWTs).",
- "$ref": "PublicKeyCredential"
- }
- },
- "id": "DeviceCredential"
- },
- "DeviceConfig": {
- "properties": {
- "version": {
- "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"
- },
- "cloudUpdateTime": {
- "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"
- },
- "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.",
- "format": "google-datetime",
- "type": "string"
- },
- "data": {
- "$ref": "DeviceConfigData",
- "description": "The device configuration data."
- }
- },
- "id": "DeviceConfig",
- "description": "The device configuration and its metadata. Eventually delivered to devices.",
- "type": "object"
- },
- "MqttConfig": {
- "properties": {
- "mqttConfigState": {
- "enumDescriptions": [
- "No MQTT state specified. If not specified, MQTT will be enabled by default.",
- "Enables a MQTT connection.",
- "Disables a MQTT connection."
- ],
- "enum": [
- "UNSPECIFIED_MQTT_STATE",
- "MQTT_ENABLED",
- "MQTT_DISABLED"
- ],
- "description": "If enabled, allows connections using the MQTT protocol. Otherwise any MQTT\nconnection to this registry will fail.",
- "type": "string"
- }
- },
- "id": "MqttConfig",
- "description": "The configuration of MQTT for a device registry.",
- "type": "object"
- },
- "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"
- },
"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.",
@@ -300,11 +21,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"
+ }
}
},
"code": {
@@ -313,10 +34,16 @@
"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"
},
"Binding": {
"properties": {
+ "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",
@@ -325,12 +52,8 @@
}
},
"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"
+ "type": "string",
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired"
}
},
"id": "Binding",
@@ -338,33 +61,33 @@
"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"
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
},
"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": {
+ "type": "string",
+ "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."
+ },
+ "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"
},
"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"
+ "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"
+ "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\""
},
"DeviceConfigData": {
"description": "The data for a device configuration. Only binary data is currently supported.",
@@ -383,41 +106,41 @@
"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"
},
"ModifyCloudToDeviceConfigRequest": {
+ "id": "ModifyCloudToDeviceConfigRequest",
"description": "Request for `ModifyCloudToDeviceConfig`.",
"type": "object",
"properties": {
+ "data": {
+ "$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.",
"format": "int64",
"type": "string"
- },
- "data": {
- "$ref": "DeviceConfigData",
- "description": "The configuration data for the device."
}
- },
- "id": "ModifyCloudToDeviceConfigRequest"
+ }
},
"GetIamPolicyRequest": {
"description": "Request message for `GetIamPolicy` method.",
@@ -443,7 +166,20 @@
"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",
@@ -451,26 +187,12 @@
"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"
- ]
- },
- "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"
}
},
"id": "AuditLogConfig"
},
"NotificationConfig": {
- "description": "Configuration to forward messages such as telemetry events.",
"type": "object",
"properties": {
"pubsubTopicName": {
@@ -478,7 +200,8 @@
"type": "string"
}
},
- "id": "NotificationConfig"
+ "id": "NotificationConfig",
+ "description": "Configuration to forward messages such as telemetry events."
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
@@ -493,13 +216,292 @@
}
},
"id": "TestIamPermissionsRequest"
+ },
+ "Policy": {
+ "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",
+ "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"
+ },
+ "ListDeviceRegistriesResponse": {
+ "description": "Response for `ListDeviceRegistries`.",
+ "type": "object",
+ "properties": {
+ "deviceRegistries": {
+ "description": "The registries that matched the query.",
+ "type": "array",
+ "items": {
+ "$ref": "DeviceRegistry"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "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`."
+ }
+ },
+ "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": {
+ "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",
+ "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."
+ ]
+ },
+ "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": {
+ "$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": {
+ "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": {
+ "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": {
+ "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": "Device"
+ },
+ "DeviceRegistry": {
+ "description": "A container for a group of devices.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
+ "type": "string"
+ },
+ "eventNotificationConfig": {
+ "$ref": "NotificationConfig",
+ "description": "Configuration to notify events received from the device."
+ },
+ "id": {
+ "description": "The identifier of this device registry. For example, `myRegistry`.",
+ "type": "string"
+ },
+ "mqttConfig": {
+ "$ref": "MqttConfig",
+ "description": "The configuration of the MQTT broker associated with this device registry,\nincluding enablement, payload data format type, etc."
+ }
+ },
+ "id": "DeviceRegistry"
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "DeviceConfig"
+ }
+ }
+ },
+ "id": "ListDeviceConfigVersionsResponse"
+ },
+ "ListDevicesResponse": {
+ "id": "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"
+ }
+ }
+ }
+ },
+ "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"
+ }
+ },
+ "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"
+ },
+ "DeviceCredential": {
+ "type": "object",
+ "properties": {
+ "publicKey": {
+ "$ref": "PublicKeyCredential",
+ "description": "A public key used to verify the signature of JSON Web Tokens (JWTs)."
+ },
+ "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"
+ }
+ },
+ "id": "DeviceCredential",
+ "description": "A server-stored device credential used for authentication."
+ },
+ "DeviceConfig": {
+ "description": "The device configuration and its metadata. Eventually delivered to devices.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "DeviceConfigData",
+ "description": "The device configuration data."
+ },
+ "version": {
+ "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"
+ },
+ "cloudUpdateTime": {
+ "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"
+ },
+ "deviceAckTime": {
+ "type": "string",
+ "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.",
+ "format": "google-datetime"
+ }
+ },
+ "id": "DeviceConfig"
+ },
+ "MqttConfig": {
+ "id": "MqttConfig",
+ "description": "The configuration of MQTT for a device registry.",
+ "type": "object",
+ "properties": {
+ "mqttConfigState": {
+ "enumDescriptions": [
+ "No MQTT state specified. If not specified, MQTT will be enabled by default.",
+ "Enables a MQTT connection.",
+ "Disables a MQTT connection."
+ ],
+ "enum": [
+ "UNSPECIFIED_MQTT_STATE",
+ "MQTT_ENABLED",
+ "MQTT_DISABLED"
+ ],
+ "description": "If enabled, allows connections using the MQTT protocol. Otherwise any MQTT\nconnection to this registry will fail.",
+ "type": "string"
+ }
+ }
+ },
+ "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"
}
},
+ "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 Iot",
"auth": {
"oauth2": {
@@ -529,14 +531,125 @@
"resources": {
"devices": {
"methods": {
- "modifyCloudToDeviceConfig": {
+ "delete": {
+ "path": "v1beta1/{+name}",
+ "id": "cloudiot.projects.locations.registries.devices.delete",
+ "description": "Deletes a device.",
"response": {
- "$ref": "DeviceConfig"
+ "$ref": "Empty"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "DELETE",
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}"
+ },
+ "list": {
+ "description": "List devices in a device registry.",
+ "response": {
+ "$ref": "ListDevicesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "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": {
+ "type": "string",
+ "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"
+ },
+ "pageSize": {
+ "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",
+ "type": "integer"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
+ "path": "v1beta1/{+parent}/devices",
+ "id": "cloudiot.projects.locations.registries.devices.list"
+ },
+ "create": {
+ "description": "Creates a device in a device registry.",
+ "request": {
+ "$ref": "Device"
+ },
"httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Device"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
+ "parameters": {
+ "parent": {
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
+ "id": "cloudiot.projects.locations.registries.devices.create",
+ "path": "v1beta1/{+parent}/devices"
+ },
+ "modifyCloudToDeviceConfig": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "DeviceConfig"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
@@ -551,47 +664,14 @@
}
},
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig",
- "path": "v1beta1/{+name}:modifyCloudToDeviceConfig",
"id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig",
+ "path": "v1beta1/{+name}:modifyCloudToDeviceConfig",
"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.",
"request": {
"$ref": "ModifyCloudToDeviceConfigRequest"
}
},
- "get": {
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}",
- "path": "v1beta1/{+name}",
- "id": "cloudiot.projects.locations.registries.devices.get",
- "description": "Gets details about a device.",
- "response": {
- "$ref": "Device"
- },
- "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"
- }
- }
- },
"patch": {
- "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"
- },
"response": {
"$ref": "Device"
},
@@ -611,30 +691,36 @@
"location": "query"
},
"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/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$"
}
+ },
+ "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",
+ "get": {
"response": {
- "$ref": "Empty"
+ "$ref": "Device"
},
"parameterOrder": [
"name"
],
+ "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",
- "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$"
+ "type": "string"
}
},
"scopes": [
@@ -642,93 +728,9 @@
"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}"
- },
- "list": {
- "response": {
- "$ref": "ListDevicesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "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": {
- "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": {
- "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": {
- "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",
- "type": "string"
- }
- },
- "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."
- },
- "create": {
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices",
- "path": "v1beta1/{+parent}/devices",
- "id": "cloudiot.projects.locations.registries.devices.create",
- "request": {
- "$ref": "Device"
- },
- "description": "Creates a device in a device registry.",
- "response": {
- "$ref": "Device"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ]
+ "path": "v1beta1/{+name}",
+ "id": "cloudiot.projects.locations.registries.devices.get",
+ "description": "Gets details about a device."
}
},
"resources": {
@@ -736,16 +738,16 @@
"methods": {
"list": {
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions",
- "path": "v1beta1/{+name}/configVersions",
"id": "cloudiot.projects.locations.registries.devices.configVersions.list",
+ "path": "v1beta1/{+name}/configVersions",
"description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first).",
- "response": {
- "$ref": "ListDeviceConfigVersionsResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListDeviceConfigVersionsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
@@ -772,7 +774,14 @@
}
},
"methods": {
- "getIamPolicy": {
+ "setIamPolicy": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy",
+ "path": "v1beta1/{+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.",
"response": {
"$ref": "Policy"
},
@@ -782,7 +791,7 @@
"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.",
+ "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/[^/]+$",
@@ -792,40 +801,65 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy",
- "path": "v1beta1/{+resource}:getIamPolicy",
- "id": "cloudiot.projects.locations.registries.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."
+ ]
},
- "get": {
- "path": "v1beta1/{+name}",
- "id": "cloudiot.projects.locations.registries.get",
- "description": "Gets a device registry configuration.",
+ "create": {
+ "request": {
+ "$ref": "DeviceRegistry"
+ },
+ "description": "Creates a device registry that contains devices.",
"response": {
"$ref": "DeviceRegistry"
},
"parameterOrder": [
- "name"
+ "parent"
],
- "httpMethod": "GET",
+ "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"
+ }
+ },
"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"
+ },
+ "getIamPolicy": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy",
+ "id": "cloudiot.projects.locations.registries.getIamPolicy",
+ "path": "v1beta1/{+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": {
- "name": {
- "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.",
- "required": true,
- "type": "string",
+ "resource": {
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
- "location": "path"
+ "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ]
},
"patch": {
"request": {
@@ -848,10 +882,10 @@
"location": "path"
},
"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"
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
@@ -862,20 +896,44 @@
"path": "v1beta1/{+name}",
"id": "cloudiot.projects.locations.registries.patch"
},
- "testIamPermissions": {
- "path": "v1beta1/{+resource}:testIamPermissions",
- "id": "cloudiot.projects.locations.registries.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.",
+ "get": {
+ "id": "cloudiot.projects.locations.registries.get",
+ "path": "v1beta1/{+name}",
+ "description": "Gets a device registry configuration.",
+ "httpMethod": "GET",
"response": {
- "$ref": "TestIamPermissionsResponse"
+ "$ref": "DeviceRegistry"
},
"parameterOrder": [
+ "name"
+ ],
+ "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}"
+ },
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudiot"
+ ],
"parameters": {
"resource": {
"location": "path",
@@ -885,13 +943,16 @@
"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}:testIamPermissions"
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions",
+ "id": "cloudiot.projects.locations.registries.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.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
},
"delete": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}",
"path": "v1beta1/{+name}",
"id": "cloudiot.projects.locations.registries.delete",
"description": "Deletes a device registry configuration.",
@@ -914,10 +975,11 @@
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$"
}
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}"
+ }
},
"list": {
+ "path": "v1beta1/{+parent}/registries",
+ "id": "cloudiot.projects.locations.registries.list",
"description": "Lists device registries.",
"response": {
"$ref": "ListDeviceRegistriesResponse"
@@ -931,86 +993,26 @@
"https://www.googleapis.com/auth/cloudiot"
],
"parameters": {
+ "pageToken": {
+ "location": "query",
+ "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"
+ },
+ "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": {
"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"
- },
- "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"
}
},
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries",
- "path": "v1beta1/{+parent}/registries",
- "id": "cloudiot.projects.locations.registries.list"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "DeviceRegistry"
- },
- "parameters": {
- "parent": {
- "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",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudiot"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries",
- "id": "cloudiot.projects.locations.registries.create",
- "path": "v1beta1/{+parent}/registries",
- "request": {
- "$ref": "DeviceRegistry"
- },
- "description": "Creates a device registry that contains devices."
- },
- "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": {
- "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy",
- "path": "v1beta1/{+resource}:setIamPolicy",
- "id": "cloudiot.projects.locations.registries.setIamPolicy"
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries"
}
}
}
@@ -1020,49 +1022,35 @@
}
},
"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": {
- "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"
+ "default": "true",
+ "location": "query"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "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": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1071,17 +1059,9 @@
"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",
@@ -1094,19 +1074,39 @@
"json",
"media",
"proto"
- ]
- },
- "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": {
+ "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"
}
- },
- "version": "v1beta1",
- "baseUrl": "https://cloudiot.googleapis.com/"
+ }
}
diff --git a/cloudkms/v1/cloudkms-api.json b/cloudkms/v1/cloudkms-api.json
index 9925102..c5e9d81 100644
--- a/cloudkms/v1/cloudkms-api.json
+++ b/cloudkms/v1/cloudkms-api.json
@@ -1,4 +1,858 @@
{
+ "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": {
+ "resources": {
+ "locations": {
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "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": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations",
+ "path": "v1/{+name}/locations",
+ "id": "cloudkms.projects.locations.list"
+ },
+ "get": {
+ "description": "Get information about a location.",
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Resource name for the location.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
+ "path": "v1/{+name}",
+ "id": "cloudkms.projects.locations.get"
+ }
+ },
+ "resources": {
+ "keyRings": {
+ "methods": {
+ "getIamPolicy": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy",
+ "id": "cloudkms.projects.locations.keyRings.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",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "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": {
+ "description": "The name of the KeyRing to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}",
+ "path": "v1/{+name}",
+ "id": "cloudkms.projects.locations.keyRings.get"
+ },
+ "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": {
+ "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/[^/]+$"
+ }
+ },
+ "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": {
+ "pageSize": {
+ "location": "query",
+ "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"
+ },
+ "parent": {
+ "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
+ "type": "string",
+ "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": {
+ "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.",
+ "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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "create": {
+ "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.",
+ "response": {
+ "$ref": "KeyRing"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "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"
+ },
+ "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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ },
+ "resources": {
+ "cryptoKeys": {
+ "methods": {
+ "get": {
+ "description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion.",
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the CryptoKey to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
+ "path": "v1/{+name}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get"
+ },
+ "patch": {
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "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}",
+ "path": "v1/{+name}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch",
+ "request": {
+ "$ref": "CryptoKey"
+ },
+ "description": "Update a CryptoKey."
+ },
+ "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/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions",
+ "path": "v1/{+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."
+ },
+ "decrypt": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt",
+ "path": "v1/{+name}:decrypt",
+ "request": {
+ "$ref": "DecryptRequest"
+ },
+ "description": "Decrypts data that was protected by Encrypt.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "DecryptResponse"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "response": {
+ "$ref": "ListCryptoKeysResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "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": {
+ "location": "path",
+ "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/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
+ "path": "v1/{+parent}/cryptoKeys",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list",
+ "description": "Lists CryptoKeys."
+ },
+ "encrypt": {
+ "request": {
+ "$ref": "EncryptRequest"
+ },
+ "description": "Encrypts data, so that it can only be recovered by a call to Decrypt.",
+ "response": {
+ "$ref": "EncryptResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "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/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt",
+ "path": "v1/{+name}:encrypt",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt"
+ },
+ "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": {
+ "description": "Required. It must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The name of the KeyRing associated with the\nCryptoKeys.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
+ "path": "v1/{+parent}/cryptoKeys",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.create"
+ },
+ "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": {
+ "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"
+ },
+ "updatePrimaryVersion": {
+ "description": "Update the version of a CryptoKey that will be used in Encrypt",
+ "request": {
+ "$ref": "UpdateCryptoKeyPrimaryVersionRequest"
+ },
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the CryptoKey to update.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
+ "path": "v1/{+name}:updatePrimaryVersion",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion"
+ },
+ "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": {
+ "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/[^/]+/cryptoKeys/[^/]+$"
+ }
+ },
+ "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"
+ }
+ },
+ "resources": {
+ "cryptoKeyVersions": {
+ "methods": {
+ "list": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
+ "path": "v1/{+parent}/cryptoKeyVersions",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list",
+ "description": "Lists CryptoKeyVersions.",
+ "response": {
+ "$ref": "ListCryptoKeyVersionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "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"
+ },
+ "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/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
+ "type": "string"
+ }
+ }
+ },
+ "create": {
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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": {
+ "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.",
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The resource name of the CryptoKeyVersion to restore.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
+ "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"
+ ]
+ },
+ "patch": {
+ "request": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "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.",
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "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": {
+ "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/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
+ "path": "v1/{+name}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "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": {
+ "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": "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": "20171212",
+ "documentationLink": "https://cloud.google.com/kms/",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
@@ -26,6 +880,8 @@
"id": "ListCryptoKeysResponse"
},
"TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
@@ -35,17 +891,17 @@
}
}
},
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object"
+ "id": "TestIamPermissionsResponse"
},
"DestroyCryptoKeyVersionRequest": {
- "properties": {},
- "id": "DestroyCryptoKeyVersionRequest",
"description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "DestroyCryptoKeyVersionRequest"
},
"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.",
@@ -71,14 +927,29 @@
"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"
+ "id": "AuditLogConfig"
},
"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": {
+ "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"
+ },
"labels": {
"description": "Labels with user-defined metadata. For more information, see\n[Labeling Keys](/kms/docs/labeling-keys).",
"type": "object",
@@ -103,23 +974,6 @@
"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"
@@ -154,33 +1008,33 @@
"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"
- },
- "name": {
- "description": "The resource name of the CryptoKeyVersion used in encryption.",
- "type": "string"
}
},
"id": "EncryptResponse"
},
"KeyRing": {
+ "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
+ "type": "object",
"properties": {
- "name": {
- "description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
- "type": "string"
- },
"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"
+ "id": "KeyRing"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
@@ -204,16 +1058,6 @@
"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",
@@ -230,16 +1074,20 @@
},
"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": "Policy"
},
- "RestoreCryptoKeyVersionRequest": {
- "description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.",
- "type": "object",
- "properties": {},
- "id": "RestoreCryptoKeyVersionRequest"
- },
"UpdateCryptoKeyPrimaryVersionRequest": {
"description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.",
"type": "object",
@@ -251,6 +1099,12 @@
},
"id": "UpdateCryptoKeyPrimaryVersionRequest"
},
+ "RestoreCryptoKeyVersionRequest": {
+ "description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.",
+ "type": "object",
+ "properties": {},
+ "id": "RestoreCryptoKeyVersionRequest"
+ },
"ListKeyRingsResponse": {
"description": "Response message for KeyManagementService.ListKeyRings.",
"type": "object",
@@ -278,12 +1132,6 @@
"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"
@@ -294,6 +1142,12 @@
"items": {
"$ref": "AuditLogConfig"
}
+ },
+ "exemptedMembers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"id": "AuditConfig"
@@ -302,28 +1156,6 @@
"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": {
- "state": {
- "enum": [
- "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED",
- "ENABLED",
- "DISABLED",
- "DESTROYED",
- "DESTROY_SCHEDULED"
- ],
- "description": "The current state of the CryptoKeyVersion.",
- "type": "string",
- "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."
- ]
- },
- "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",
@@ -338,6 +1170,28 @@
"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"
@@ -346,14 +1200,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": {
- "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"
@@ -376,6 +1230,8 @@
"id": "DecryptRequest"
},
"Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
"properties": {
"condition": {
"$ref": "Expr",
@@ -393,22 +1249,12 @@
"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": {
- "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"
@@ -416,6 +1262,14 @@
"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"
+ },
+ "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"
}
},
"id": "Expr"
@@ -438,6 +1292,8 @@
"id": "EncryptRequest"
},
"ListCryptoKeyVersionsResponse": {
+ "description": "Response message for KeyManagementService.ListCryptoKeyVersions.",
+ "type": "object",
"properties": {
"cryptoKeyVersions": {
"description": "The list of CryptoKeyVersions.",
@@ -456,25 +1312,12 @@
"type": "integer"
}
},
- "id": "ListCryptoKeyVersionsResponse",
- "description": "Response message for KeyManagementService.ListCryptoKeyVersions.",
- "type": "object"
+ "id": "ListCryptoKeyVersionsResponse"
},
"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"
@@ -486,868 +1329,25 @@
"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"
}
},
- "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 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": {
- "resources": {
- "locations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "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": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations",
- "path": "v1/{+name}/locations",
- "id": "cloudkms.projects.locations.list",
- "description": "Lists information about the supported locations for this service."
- },
- "get": {
- "description": "Get information about a location.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Resource name for the location.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
- "id": "cloudkms.projects.locations.get",
- "path": "v1/{+name}"
- }
- },
- "resources": {
- "keyRings": {
- "resources": {
- "cryptoKeys": {
- "methods": {
- "list": {
- "path": "v1/{+parent}/cryptoKeys",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list",
- "description": "Lists CryptoKeys.",
- "response": {
- "$ref": "ListCryptoKeysResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
- "type": "string"
- },
- "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": {
- "location": "path",
- "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/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys"
- },
- "encrypt": {
- "path": "v1/{+name}:encrypt",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt",
- "request": {
- "$ref": "EncryptRequest"
- },
- "description": "Encrypts data, so that it can only be recovered by a call to Decrypt.",
- "response": {
- "$ref": "EncryptResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "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"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt"
- },
- "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"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "CryptoKey"
- },
- "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": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path",
- "description": "Required. The name of the KeyRing associated with the\nCryptoKeys.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.create",
- "path": "v1/{+parent}/cryptoKeys",
- "request": {
- "$ref": "CryptoKey"
- },
- "description": "Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required."
- },
- "updatePrimaryVersion": {
- "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"
- },
- "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/[^/]+$"
- }
- }
- },
- "getIamPolicy": {
- "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/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "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."
- },
- "patch": {
- "description": "Update a CryptoKey.",
- "request": {
- "$ref": "CryptoKey"
- },
- "response": {
- "$ref": "CryptoKey"
- },
- "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": {
- "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch"
- },
- "get": {
- "description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion.",
- "response": {
- "$ref": "CryptoKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path",
- "description": "The name of the CryptoKey to get.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get"
- },
- "testIamPermissions": {
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions",
- "path": "v1/{+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.",
- "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/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions"
- },
- "decrypt": {
- "description": "Decrypts data that was protected by Encrypt.",
- "request": {
- "$ref": "DecryptRequest"
- },
- "response": {
- "$ref": "DecryptResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the CryptoKey to use for decryption.\nThe server will choose the appropriate version.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
- "path": "v1/{+name}:decrypt",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt"
- }
- },
- "resources": {
- "cryptoKeyVersions": {
- "methods": {
- "list": {
- "path": "v1/{+parent}/cryptoKeyVersions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list",
- "description": "Lists CryptoKeyVersions.",
- "response": {
- "$ref": "ListCryptoKeyVersionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "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": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
- "required": true,
- "type": "string"
- }
- },
- "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",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create",
- "path": "v1/{+parent}/cryptoKeyVersions",
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path",
- "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "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": {
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path",
- "description": "The resource name of the CryptoKeyVersion to restore.",
- "required": true,
- "type": "string"
- }
- },
- "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",
- "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.",
- "request": {
- "$ref": "RestoreCryptoKeyVersionRequest"
- }
- },
- "get": {
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path",
- "description": "The name of the CryptoKeyVersion to get.",
- "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.get",
- "description": "Returns metadata for a given CryptoKeyVersion."
- },
- "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": {
- "location": "query",
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "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/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch"
- }
- }
- }
- }
- }
- },
- "methods": {
- "create": {
- "response": {
- "$ref": "KeyRing"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- },
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
- "path": "v1/{+parent}/keyRings",
- "id": "cloudkms.projects.locations.keyRings.create",
- "description": "Create a new KeyRing in a given Project and Location.",
- "request": {
- "$ref": "KeyRing"
- }
- },
- "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": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
- },
- "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": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "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/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.getIamPolicy"
- },
- "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}",
- "path": "v1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.get"
- },
- "testIamPermissions": {
- "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": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
- }
- },
- "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",
- "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."
- },
- "list": {
- "response": {
- "$ref": "ListKeyRingsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "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"
- },
- "parent": {
- "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
- "path": "v1/{+parent}/keyRings",
- "id": "cloudkms.projects.locations.keyRings.list",
- "description": "Lists KeyRings."
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "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": {
- "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": {
- "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": {
- "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"
- }
- },
- "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": "",
- "revision": "20171212",
- "documentationLink": "https://cloud.google.com/kms/",
- "id": "cloudkms:v1"
+ "protocol": "rest"
}
diff --git a/cloudresourcemanager/v1/cloudresourcemanager-api.json b/cloudresourcemanager/v1/cloudresourcemanager-api.json
index 19e9b20..ce097f0 100644
--- a/cloudresourcemanager/v1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v1/cloudresourcemanager-api.json
@@ -1,81 +1,1035 @@
{
+ "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": {
+ "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": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ }
+ },
+ "id": "Status"
+ },
+ "ListLiensResponse": {
+ "type": "object",
+ "properties": {
+ "liens": {
+ "type": "array",
+ "items": {
+ "$ref": "Lien"
+ },
+ "description": "A list of Liens."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list."
+ }
+ },
+ "id": "ListLiensResponse",
+ "description": "The response message for Liens.ListLiens."
+ },
+ "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": {
+ "type": "string",
+ "description": "The human readable name.\n\nMutable."
+ },
+ "description": {
+ "description": "Detailed description of what this `Constraint` controls as well as how and\nwhere it is enforced.\n\nMutable.",
+ "type": "string"
+ },
+ "booleanConstraint": {
+ "$ref": "BooleanConstraint",
+ "description": "Defines this constraint as being a BooleanConstraint."
+ },
+ "constraintDefault": {
+ "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"
+ ],
+ "description": "The evaluation behavior of this constraint in the absense of 'Policy'."
+ },
+ "name": {
+ "description": "Immutable value, required to globally be unique. For example,\n`constraints/serviceuser.services`",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "Constraint"
+ },
+ "Binding": {
+ "type": "object",
+ "properties": {
+ "role": {
+ "type": "string",
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired"
+ },
+ "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"
+ }
+ },
+ "id": "Binding",
+ "description": "Associates `members` with a `role`."
+ },
+ "GetOrgPolicyRequest": {
+ "type": "object",
+ "properties": {
+ "constraint": {
+ "type": "string",
+ "description": "Name of the `Constraint` to get the `Policy`."
+ }
+ },
+ "id": "GetOrgPolicyRequest",
+ "description": "The request sent to the GetOrgPolicy method."
+ },
+ "RestoreDefault": {
+ "type": "object",
+ "properties": {},
+ "id": "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."
+ },
+ "ClearOrgPolicyRequest": {
+ "description": "The request sent to the ClearOrgPolicy method.",
+ "type": "object",
+ "properties": {
+ "etag": {
+ "type": "string",
+ "description": "The current version, for concurrency control. Not sending an `etag`\nwill cause the `Policy` to be cleared blindly.",
+ "format": "byte"
+ },
+ "constraint": {
+ "type": "string",
+ "description": "Name of the `Constraint` of the `Policy` to clear."
+ }
+ },
+ "id": "ClearOrgPolicyRequest"
+ },
+ "UndeleteProjectRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "UndeleteProjectRequest",
+ "description": "The request sent to the UndeleteProject\nmethod."
+ },
+ "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": {
+ "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": {
+ "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": {
+ "type": "object",
+ "properties": {},
+ "id": "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."
+ },
+ "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."
+ },
+ "GetIamPolicyRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest",
+ "description": "Request message for `GetIamPolicy` method."
+ },
+ "OrganizationOwner": {
+ "type": "object",
+ "properties": {
+ "directoryCustomerId": {
+ "description": "The Google for Work customer id used in the Directory API.",
+ "type": "string"
+ }
+ },
+ "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."
+ },
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "Project"
+ },
+ "description": "The list of Projects that matched the list filter. This list can\nbe paginated."
+ },
+ "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": {
+ "projectNumber": {
+ "type": "string",
+ "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
+ "format": "int64"
+ },
+ "parent": {
+ "$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": {
+ "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": {
+ "type": "string",
+ "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."
+ },
+ "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": {
+ "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"
+ ],
+ "description": "The Project lifecycle state.\n\nRead-only."
+ }
+ },
+ "id": "Project"
+ },
+ "SearchOrganizationsResponse": {
+ "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",
+ "description": "The response returned from the `SearchOrganizations` method."
+ },
+ "ListOrgPoliciesResponse": {
+ "description": "The response returned from the ListOrgPolicies method. It will be empty\nif no `Policies` are set on the resource.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "policies": {
+ "type": "array",
+ "items": {
+ "$ref": "OrgPolicy"
+ },
+ "description": "The `Policies` that are set on the resource. It will be empty if no\n`Policies` are set."
+ }
+ },
+ "id": "ListOrgPoliciesResponse"
+ },
+ "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."
+ },
+ "OrgPolicy": {
+ "type": "object",
+ "properties": {
+ "updateTime": {
+ "type": "string",
+ "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.",
+ "format": "google-datetime"
+ },
+ "version": {
+ "type": "integer",
+ "description": "Version of the `Policy`. Default version is 0;",
+ "format": "int32"
+ },
+ "restoreDefault": {
+ "$ref": "RestoreDefault",
+ "description": "Restores the default behavior of the constraint; independent of\n`Constraint` type."
+ },
+ "listPolicy": {
+ "$ref": "ListPolicy",
+ "description": "List of values either allowed or disallowed."
+ },
+ "etag": {
+ "type": "string",
+ "description": "An opaque tag indicating the current version of the `Policy`, used for\nconcurrency control.\n\nWhen the `Policy` is returned from either a `GetPolicy` or a\n`ListOrgPolicy` request, this `etag` indicates the version of the current\n`Policy` to use when executing a read-modify-write loop.\n\nWhen the `Policy` is returned from a `GetEffectivePolicy` request, the\n`etag` will be unset.\n\nWhen the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value\nthat was returned from a `GetOrgPolicy` request as part of a\nread-modify-write loop for concurrency control. Not setting the `etag`in a\n`SetOrgPolicy` request will result in an unconditional write of the\n`Policy`.",
+ "format": "byte"
+ },
+ "constraint": {
+ "description": "The name of the `Constraint` the `Policy` is configuring, for example,\n`constraints/serviceuser.services`.\n\nImmutable after creation.",
+ "type": "string"
+ },
+ "booleanPolicy": {
+ "$ref": "BooleanPolicy",
+ "description": "For boolean `Constraints`, whether to enforce the `Constraint` or not."
+ }
+ },
+ "id": "OrgPolicy",
+ "description": "Defines a Cloud Organization `Policy` which is used to specify `Constraints`\nfor configurations of Cloud Platform resources."
+ },
+ "BooleanPolicy": {
+ "type": "object",
+ "properties": {
+ "enforced": {
+ "type": "boolean",
+ "description": "If `true`, then the `Policy` is enforced. If `false`, then any\nconfiguration is acceptable.\n\nSuppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`\nwith `constraint_default` set to `ALLOW`. A `Policy` for that\n`Constraint` exhibits the following behavior:\n - If the `Policy` at this resource has enforced set to `false`, serial\n port connection attempts will be allowed.\n - If the `Policy` at this resource has enforced set to `true`, serial\n port connection attempts will be refused.\n - If the `Policy` at this resource is `RestoreDefault`, serial port\n connection attempts will be allowed.\n - If no `Policy` is set at this resource or anywhere higher in the\n resource hierarchy, serial port connection attempts will be allowed.\n - If no `Policy` is set at this resource, but one exists higher in the\n resource hierarchy, the behavior is as if the`Policy` were set at\n this resource.\n\nThe following examples demonstrate the different possible layerings:\n\nExample 1 (nearest `Constraint` wins):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has no `Policy` set.\nThe constraint at `projects/bar` and `organizations/foo` will not be\nenforced.\n\nExample 2 (enforcement gets replaced):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has a `Policy` with:\n {enforced: true}\nThe constraint at `organizations/foo` is not enforced.\nThe constraint at `projects/bar` is enforced.\n\nExample 3 (RestoreDefault):\n `organizations/foo` has a `Policy` with:\n {enforced: true}\n `projects/bar` has a `Policy` with:\n {RestoreDefault: {}}\nThe constraint at `organizations/foo` is enforced.\nThe constraint at `projects/bar` is not enforced, because\n`constraint_default` for the `Constraint` is `ALLOW`."
+ }
+ },
+ "id": "BooleanPolicy",
+ "description": "Used in `policy_type` to specify how `boolean_policy` will behave at this\nresource."
+ },
+ "Lien": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "A system-generated unique identifier for this Lien.\n\nExample: `liens/1234abcd`"
+ },
+ "reason": {
+ "description": "Concise user-visible strings indicating why an action cannot be performed\non a resource. Maximum lenth of 200 characters.\n\nExample: 'Holds production API key'",
+ "type": "string"
+ },
+ "origin": {
+ "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": {
+ "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": {
+ "type": "string",
+ "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`"
+ },
+ "createTime": {
+ "description": "The creation time of this Lien.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Lien",
+ "description": "A Lien represents an encumbrance on the actions that can be performed on a\nresource."
+ },
+ "Ancestor": {
+ "type": "object",
+ "properties": {
+ "resourceId": {
+ "$ref": "ResourceId",
+ "description": "Resource id of the ancestor."
+ }
+ },
+ "id": "Ancestor",
+ "description": "Identifying information for a single ancestor of a project."
+ },
+ "ListConstraint": {
+ "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",
+ "description": "A `Constraint` that allows or disallows a list of string values, which are\nconfigured by an Organization's policy administrator with a `Policy`."
+ },
+ "SetOrgPolicyRequest": {
+ "description": "The request sent to the SetOrgPolicyRequest method.",
+ "type": "object",
+ "properties": {
+ "policy": {
+ "$ref": "OrgPolicy",
+ "description": "`Policy` to set on the resource."
+ }
+ },
+ "id": "SetOrgPolicyRequest"
+ },
+ "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": {
+ "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",
+ "description": "Request message for `SetIamPolicy` method."
+ },
+ "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": {
+ "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
+ "type": "object",
+ "properties": {
+ "creationTime": {
+ "type": "string",
+ "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
+ "format": "google-datetime"
+ },
+ "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."
+ },
+ "lifecycleState": {
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED"
+ ],
+ "description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly",
+ "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": {
+ "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": {
+ "type": "string",
+ "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"
+ }
+ },
+ "id": "Organization"
+ },
+ "ListAvailableOrgPolicyConstraintsResponse": {
+ "type": "object",
+ "properties": {
+ "constraints": {
+ "type": "array",
+ "items": {
+ "$ref": "Constraint"
+ },
+ "description": "The collection of constraints that are settable on the request resource."
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "Page token used to retrieve the next page. This is currently not used."
+ }
+ },
+ "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)."
+ },
+ "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": {
+ "enum": [
+ "ALL_VALUES_UNSPECIFIED",
+ "ALLOW",
+ "DENY"
+ ],
+ "description": "The policy all_values state.",
+ "type": "string",
+ "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."
+ ]
+ },
+ "allowedValues": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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`."
+ },
+ "suggestedValue": {
+ "type": "string",
+ "description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Policy`. If `suggested_value`\nis not set, it will inherit the value specified higher in the hierarchy,\nunless `inherit_from_parent` is `false`."
+ },
+ "inheritFromParent": {
+ "description": "Determines the inheritance behavior for this `Policy`.\n\nBy default, a `ListPolicy` set at a resource supercedes any `Policy` set\nanywhere up the resource hierarchy. However, if `inherit_from_parent` is\nset to `true`, then the values from the effective `Policy` of the parent\nresource are inherited, meaning the values set in this `Policy` are\nadded to the values inherited up the hierarchy.\n\nSetting `Policy` hierarchies that inherit both allowed values and denied\nvalues isn't recommended in most circumstances to keep the configuration\nsimple and understandable. However, it is possible to set a `Policy` with\n`allowed_values` set that inherits a `Policy` with `denied_values` set.\nIn this case, the values that are allowed must be in `allowed_values` and\nnot present in `denied_values`.\n\nFor example, suppose you have a `Constraint`\n`constraints/serviceuser.services`, which has a `constraint_type` of\n`list_constraint`, and with `constraint_default` set to `ALLOW`.\nSuppose that at the Organization level, a `Policy` is applied that\nrestricts the allowed API activations to {`E1`, `E2`}. Then, if a\n`Policy` is applied to a project below the Organization that has\n`inherit_from_parent` set to `false` and field all_values set to DENY,\nthen an attempt to activate any API will be denied.\n\nThe following examples demonstrate different possible layerings:\n\nExample 1 (no inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n ``projects/bar`` has `inherit_from_parent` `false` and values:\n {allowed_values: \"E3\" allowed_values: \"E4\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E3`, and `E4`.\n\nExample 2 (inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n `projects/bar` has a `Policy` with values:\n {value: “E3” value: ”E4” inherit_from_parent: true}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.\n\nExample 3 (inheriting both allowed and denied values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values: \"E2\"}\n `projects/bar` has a `Policy` with:\n {denied_values: \"E1\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe value accepted at `projects/bar` is `E2`.\n\nExample 4 (RestoreDefault):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n `projects/bar` has a `Policy` with values:\n {RestoreDefault: {}}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 5 (no policy inherits parent policy):\n `organizations/foo` has no `Policy` set.\n `projects/bar` has no `Policy` set.\nThe accepted values at both levels are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 6 (ListConstraint allowing all):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values: ”E2”}\n `projects/bar` has a `Policy` with:\n {all: ALLOW}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nAny value is accepted at `projects/bar`.\n\nExample 7 (ListConstraint allowing none):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values: ”E2”}\n `projects/bar` has a `Policy` with:\n {all: DENY}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nNo value is accepted at `projects/bar`.",
+ "type": "boolean"
+ },
+ "deniedValues": {
+ "type": "array",
+ "items": {
+ "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"
+ },
+ "GetAncestryResponse": {
+ "type": "object",
+ "properties": {
+ "ancestor": {
+ "type": "array",
+ "items": {
+ "$ref": "Ancestor"
+ },
+ "description": "Ancestors are ordered from bottom to top of the resource hierarchy. The\nfirst ancestor is the project itself, followed by the project's parent,\netc."
+ }
+ },
+ "id": "GetAncestryResponse",
+ "description": "Response from the GetAncestry method."
+ },
+ "AuditLogConfig": {
+ "type": "object",
+ "properties": {
+ "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"
+ ]
+ },
+ "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."
+ }
+ },
+ "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."
+ },
+ "SearchOrganizationsRequest": {
+ "type": "object",
+ "properties": {
+ "filter": {
+ "type": "string",
+ "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."
+ },
+ "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",
+ "description": "The request sent to the `SearchOrganizations` method."
+ },
+ "GetAncestryRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "GetAncestryRequest",
+ "description": "The request sent to the\nGetAncestry\nmethod."
+ },
+ "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": {
+ "type": "object",
+ "properties": {
+ "pageToken": {
+ "type": "string",
+ "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."
+ },
+ "pageSize": {
+ "type": "integer",
+ "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"
+ }
+ },
+ "id": "ListAvailableOrgPolicyConstraintsRequest",
+ "description": "The request sent to the [ListAvailableOrgPolicyConstraints]\ngoogle.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method."
+ },
+ "Policy": {
+ "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": {
+ "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": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "type": "array",
+ "items": {
+ "$ref": "AuditConfig"
+ }
+ }
+ },
+ "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)."
+ },
+ "FolderOperation": {
+ "type": "object",
+ "properties": {
+ "destinationParent": {
+ "type": "string",
+ "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to."
+ },
+ "operationType": {
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "CREATE",
+ "MOVE"
+ ],
+ "description": "The type of this operation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Operation type not specified.",
+ "A create folder operation.",
+ "A move folder operation."
+ ]
+ },
+ "displayName": {
+ "type": "string",
+ "description": "The display name of the folder."
+ },
+ "sourceParent": {
+ "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
+ "type": "string"
+ }
+ },
+ "id": "FolderOperation",
+ "description": "Metadata describing a long running folder operation"
+ },
+ "ResourceId": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\""
+ },
+ "id": {
+ "type": "string",
+ "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's."
+ }
+ },
+ "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."
+ },
+ "GetEffectiveOrgPolicyRequest": {
+ "type": "object",
+ "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."
+ },
+ "ListOrgPoliciesRequest": {
+ "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": {
+ "type": "integer",
+ "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"
+ }
+ },
+ "id": "ListOrgPoliciesRequest",
+ "description": "The request sent to the ListOrgPolicies method."
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "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`."
+ },
+ "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."
+ }
+ },
+ "id": "Operation"
+ },
+ "AuditConfig": {
+ "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"
+ }
+ }
+ },
+ "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."
+ }
+ },
+ "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 Resource Manager",
+ "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"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://cloudresourcemanager.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudresourcemanager",
+ "batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Cloud Resource Manager API",
"ownerName": "Google",
"resources": {
"organizations": {
"methods": {
- "clearOrgPolicy": {
- "description": "Clears a `Policy` from a resource.",
+ "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": "ClearOrgPolicyRequest"
+ "$ref": "GetEffectiveOrgPolicyRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"resource"
],
"response": {
+ "$ref": "OrgPolicy"
+ },
+ "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": "^organizations/[^/]+$"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy",
+ "id": "cloudresourcemanager.organizations.getEffectiveOrgPolicy",
+ "path": "v1/{+resource}:getEffectiveOrgPolicy"
+ },
+ "get": {
+ "description": "Fetches an Organization resource identified by the specified resource name.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Organization"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\"."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}",
+ "id": "cloudresourcemanager.organizations.get",
+ "path": "v1/{+name}"
+ },
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "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."
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}:testIamPermissions",
+ "id": "cloudresourcemanager.organizations.testIamPermissions",
+ "path": "v1/{+resource}: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": {
+ "request": {
+ "$ref": "ClearOrgPolicyRequest"
+ },
+ "description": "Clears a `Policy` from a resource.",
+ "response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "Name of the resource for the `Policy` to clear.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
"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",
- "id": "cloudresourcemanager.organizations.clearOrgPolicy",
- "path": "v1/{+resource}:clearOrgPolicy"
+ "path": "v1/{+resource}:clearOrgPolicy",
+ "id": "cloudresourcemanager.organizations.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": {
- "pattern": "^organizations/[^/]+$",
"location": "path",
"description": "Resource name of the resource to attach the `Policy`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^organizations/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/organizations/{organizationsId}:setOrgPolicy",
- "path": "v1/{+resource}:setOrgPolicy",
"id": "cloudresourcemanager.organizations.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"
+ "path": "v1/{+resource}:setOrgPolicy"
},
"setIamPolicy": {
"flatPath": "v1/organizations/{organizationsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
"id": "cloudresourcemanager.organizations.setIamPolicy",
+ "path": "v1/{+resource}: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"
},
- "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",
- "response": {
- "$ref": "Policy"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"resource": {
"location": "path",
@@ -84,10 +1038,7 @@
"type": "string",
"pattern": "^organizations/[^/]+$"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ }
},
"listAvailableOrgPolicyConstraints": {
"response": {
@@ -97,28 +1048,32 @@
"resource"
],
"httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^organizations/[^/]+$",
- "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"
],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "Name of the resource to list `Constraints` for.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
"flatPath": "v1/organizations/{organizationsId}:listAvailableOrgPolicyConstraints",
"path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
"id": "cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints",
+ "description": "Lists `Constraints` that could be applied on the specified resource.",
"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"
+ },
"response": {
"$ref": "ListOrgPoliciesResponse"
},
@@ -141,13 +1096,13 @@
},
"flatPath": "v1/organizations/{organizationsId}:listOrgPolicies",
"path": "v1/{+resource}:listOrgPolicies",
- "id": "cloudresourcemanager.organizations.listOrgPolicies",
- "description": "Lists all the `Policies` set for a particular resource.",
- "request": {
- "$ref": "ListOrgPoliciesRequest"
- }
+ "id": "cloudresourcemanager.organizations.listOrgPolicies"
},
"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"
@@ -155,61 +1110,38 @@
"response": {
"$ref": "Policy"
},
+ "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": "v1/organizations/{organizationsId}:getIamPolicy",
+ "id": "cloudresourcemanager.organizations.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy"
+ },
+ "getOrgPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "OrgPolicy"
+ },
"parameters": {
"resource": {
"required": true,
"type": "string",
"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."
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:getIamPolicy",
- "id": "cloudresourcemanager.organizations.getIamPolicy",
- "path": "v1/{+resource}: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"
- }
- },
- "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchOrganizationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {},
- "flatPath": "v1/organizations:search",
- "id": "cloudresourcemanager.organizations.search",
- "path": "v1/organizations:search"
- },
- "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": "^organizations/[^/]+$",
- "location": "path"
+ "description": "Name of the resource the `Policy` is set on."
}
},
"scopes": [
@@ -217,110 +1149,44 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/organizations/{organizationsId}:getOrgPolicy",
- "path": "v1/{+resource}:getOrgPolicy",
"id": "cloudresourcemanager.organizations.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."
},
- "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": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "The name of the resource to start computing the effective `Policy`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy",
- "path": "v1/{+resource}:getEffectiveOrgPolicy",
- "id": "cloudresourcemanager.organizations.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.",
+ "search": {
+ "flatPath": "v1/organizations:search",
+ "id": "cloudresourcemanager.organizations.search",
+ "path": "v1/organizations:search",
"request": {
- "$ref": "GetEffectiveOrgPolicyRequest"
- }
- },
- "get": {
- "description": "Fetches an Organization resource identified by the specified resource name.",
- "response": {
- "$ref": "Organization"
+ "$ref": "SearchOrganizationsRequest"
},
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\"."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations/{organizationsId}",
- "path": "v1/{+name}",
- "id": "cloudresourcemanager.organizations.get"
- },
- "testIamPermissions": {
+ "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`",
"httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
+ "parameterOrder": [],
"response": {
- "$ref": "TestIamPermissionsResponse"
+ "$ref": "SearchOrganizationsResponse"
},
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "resource": {
- "pattern": "^organizations/[^/]+$",
- "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/organizations/{organizationsId}:testIamPermissions",
- "id": "cloudresourcemanager.organizations.testIamPermissions",
- "path": "v1/{+resource}: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"
- }
+ ]
}
}
},
"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"
- },
+ "httpMethod": "DELETE",
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
@@ -335,32 +1201,33 @@
}
},
"flatPath": "v1/liens/{liensId}",
+ "id": "cloudresourcemanager.liens.delete",
"path": "v1/{+name}",
- "id": "cloudresourcemanager.liens.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`."
},
"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`.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListLiensResponse"
},
"parameterOrder": [],
- "httpMethod": "GET",
"parameters": {
- "pageSize": {
- "description": "The maximum number of items to return. This is a suggestion for the server.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
"parent": {
+ "type": "string",
"location": "query",
- "description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.",
- "type": "string"
+ "description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`."
},
"pageToken": {
- "description": "The `next_page_token` value returned from a previous List request, if any.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "The `next_page_token` value returned from a previous List request, if any."
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of items to return. This is a suggestion for the server.",
+ "format": "int32",
+ "type": "integer"
}
},
"scopes": [
@@ -368,27 +1235,27 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/liens",
- "path": "v1/liens",
- "id": "cloudresourcemanager.liens.list"
+ "id": "cloudresourcemanager.liens.list",
+ "path": "v1/liens"
},
"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"
- },
+ "httpMethod": "POST",
+ "parameterOrder": [],
"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",
+ "id": "cloudresourcemanager.liens.create",
"path": "v1/liens",
- "id": "cloudresourcemanager.liens.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"
+ }
}
}
},
@@ -396,20 +1263,20 @@
"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.",
+ "httpMethod": "GET",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
"parameters": {
"name": {
+ "location": "path",
+ "description": "The name of the operation resource.",
"required": true,
"type": "string",
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource."
+ "pattern": "^operations/.+$"
}
},
"scopes": [
@@ -417,21 +1284,14 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "cloudresourcemanager.operations.get"
+ "id": "cloudresourcemanager.operations.get",
+ "path": "v1/{+name}"
}
}
},
"folders": {
"methods": {
"clearOrgPolicy": {
- "flatPath": "v1/folders/{foldersId}:clearOrgPolicy",
- "path": "v1/{+resource}:clearOrgPolicy",
- "id": "cloudresourcemanager.folders.clearOrgPolicy",
- "description": "Clears a `Policy` from a resource.",
- "request": {
- "$ref": "ClearOrgPolicyRequest"
- },
"response": {
"$ref": "Empty"
},
@@ -450,15 +1310,16 @@
"location": "path",
"description": "Name of the resource for the `Policy` to clear."
}
+ },
+ "flatPath": "v1/folders/{foldersId}:clearOrgPolicy",
+ "path": "v1/{+resource}:clearOrgPolicy",
+ "id": "cloudresourcemanager.folders.clearOrgPolicy",
+ "description": "Clears a `Policy` from a resource.",
+ "request": {
+ "$ref": "ClearOrgPolicyRequest"
}
},
"setOrgPolicy": {
- "id": "cloudresourcemanager.folders.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"
@@ -468,30 +1329,32 @@
},
"parameters": {
"resource": {
- "location": "path",
- "description": "Resource name of the resource to attach the `Policy`.",
"required": true,
"type": "string",
- "pattern": "^folders/[^/]+$"
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "Resource name of the resource to attach the `Policy`."
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/folders/{foldersId}:setOrgPolicy"
+ "flatPath": "v1/folders/{foldersId}:setOrgPolicy",
+ "id": "cloudresourcemanager.folders.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`."
},
"listAvailableOrgPolicyConstraints": {
- "response": {
- "$ref": "ListAvailableOrgPolicyConstraintsResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
+ "response": {
+ "$ref": "ListAvailableOrgPolicyConstraintsResponse"
+ },
"parameters": {
"resource": {
"location": "path",
@@ -501,13 +1364,17 @@
"pattern": "^folders/[^/]+$"
}
},
+ "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",
- "description": "Lists `Constraints` that could be applied on the specified resource.",
+ "path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
"request": {
"$ref": "ListAvailableOrgPolicyConstraintsRequest"
- }
+ },
+ "description": "Lists `Constraints` that could be applied on the specified resource."
},
"listOrgPolicies": {
"response": {
@@ -517,35 +1384,39 @@
"resource"
],
"httpMethod": "POST",
+ "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"
],
- "parameters": {
- "resource": {
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "Name of the resource to list Policies for.",
- "required": true,
- "type": "string"
- }
- },
"flatPath": "v1/folders/{foldersId}:listOrgPolicies",
"path": "v1/{+resource}:listOrgPolicies",
"id": "cloudresourcemanager.folders.listOrgPolicies",
- "description": "Lists all the `Policies` set for a particular resource.",
"request": {
"$ref": "ListOrgPoliciesRequest"
- }
+ },
+ "description": "Lists all the `Policies` set for a particular resource."
},
"getOrgPolicy": {
- "response": {
- "$ref": "OrgPolicy"
+ "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"
},
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "OrgPolicy"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
@@ -560,20 +1431,10 @@
}
},
"flatPath": "v1/folders/{foldersId}:getOrgPolicy",
- "path": "v1/{+resource}:getOrgPolicy",
"id": "cloudresourcemanager.folders.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"
- }
+ "path": "v1/{+resource}:getOrgPolicy"
},
"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"
@@ -581,219 +1442,65 @@
"response": {
"$ref": "OrgPolicy"
},
- "parameters": {
- "resource": {
- "pattern": "^folders/[^/]+$",
- "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/folders/{foldersId}:getEffectiveOrgPolicy"
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "The name of the resource to start computing the effective `Policy`."
+ }
+ },
+ "flatPath": "v1/folders/{foldersId}:getEffectiveOrgPolicy",
+ "id": "cloudresourcemanager.folders.getEffectiveOrgPolicy",
+ "path": "v1/{+resource}: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": {
- "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.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Project"
- },
- "parameterOrder": [
- "projectId"
- ],
- "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}",
- "id": "cloudresourcemanager.projects.get",
- "path": "v1/projects/{projectId}"
- },
- "getAncestry": {
- "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.",
- "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"
- ]
- },
- "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": {
- "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"
- ],
- "flatPath": "v1/projects/{resource}:testIamPermissions",
- "id": "cloudresourcemanager.projects.testIamPermissions",
- "path": "v1/projects/{resource}: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,\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": {
- "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"
- },
- "clearOrgPolicy": {
- "request": {
- "$ref": "ClearOrgPolicyRequest"
- },
- "description": "Clears a `Policy` from a resource.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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",
- "id": "cloudresourcemanager.projects.clearOrgPolicy",
- "path": "v1/{+resource}:clearOrgPolicy"
- },
- "setIamPolicy": {
- "flatPath": "v1/projects/{resource}:setIamPolicy",
- "path": "v1/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()`;\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"
- ]
- },
"listAvailableOrgPolicyConstraints": {
- "request": {
- "$ref": "ListAvailableOrgPolicyConstraintsRequest"
- },
- "description": "Lists `Constraints` that could be applied on the specified resource.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
"response": {
"$ref": "ListAvailableOrgPolicyConstraintsResponse"
},
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Name of the resource to list `Constraints` for."
- }
- },
"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 `Constraints` for.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
"flatPath": "v1/projects/{projectsId}:listAvailableOrgPolicyConstraints",
+ "id": "cloudresourcemanager.projects.listAvailableOrgPolicyConstraints",
"path": "v1/{+resource}:listAvailableOrgPolicyConstraints",
- "id": "cloudresourcemanager.projects.listAvailableOrgPolicyConstraints"
+ "description": "Lists `Constraints` that could be applied on the specified resource.",
+ "request": {
+ "$ref": "ListAvailableOrgPolicyConstraintsRequest"
+ }
},
"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",
"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",
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -801,6 +1508,10 @@
"response": {
"$ref": "Policy"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"resource": {
"required": true,
@@ -809,55 +1520,51 @@
"description": "REQUIRED: The resource for which the policy 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"
- ],
"flatPath": "v1/projects/{resource}:getIamPolicy",
"id": "cloudresourcemanager.projects.getIamPolicy",
"path": "v1/projects/{resource}:getIamPolicy"
},
"getOrgPolicy": {
- "flatPath": "v1/projects/{projectsId}:getOrgPolicy",
- "id": "cloudresourcemanager.projects.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": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Name of the resource the `Policy` is set on.",
- "required": true,
- "type": "string"
- }
- },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
+ ],
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource the `Policy` is set on."
+ }
+ },
+ "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"
+ }
},
"undelete": {
"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.",
"request": {
"$ref": "UndeleteProjectRequest"
},
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Empty"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -870,46 +1577,46 @@
}
},
"flatPath": "v1/projects/{projectId}:undelete",
- "path": "v1/projects/{projectId}:undelete",
- "id": "cloudresourcemanager.projects.undelete"
+ "id": "cloudresourcemanager.projects.undelete",
+ "path": "v1/projects/{projectId}:undelete"
},
"getEffectiveOrgPolicy": {
- "path": "v1/{+resource}:getEffectiveOrgPolicy",
- "id": "cloudresourcemanager.projects.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"
- },
- "response": {
- "$ref": "OrgPolicy"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "OrgPolicy"
+ },
+ "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"
],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "The name of the resource to start computing the effective `Policy`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
+ "flatPath": "v1/projects/{projectsId}:getEffectiveOrgPolicy",
+ "id": "cloudresourcemanager.projects.getEffectiveOrgPolicy",
+ "path": "v1/{+resource}:getEffectiveOrgPolicy",
+ "request": {
+ "$ref": "GetEffectiveOrgPolicyRequest"
},
- "flatPath": "v1/projects/{projectsId}: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."
},
"update": {
- "response": {
- "$ref": "Project"
- },
+ "httpMethod": "PUT",
"parameterOrder": [
"projectId"
],
- "httpMethod": "PUT",
+ "response": {
+ "$ref": "Project"
+ },
"parameters": {
"projectId": {
"location": "path",
@@ -922,8 +1629,8 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectId}",
- "path": "v1/projects/{projectId}",
"id": "cloudresourcemanager.projects.update",
+ "path": "v1/projects/{projectId}",
"request": {
"$ref": "Project"
},
@@ -931,10 +1638,10 @@
},
"list": {
"httpMethod": "GET",
- "parameterOrder": [],
"response": {
"$ref": "ListProjectsResponse"
},
+ "parameterOrder": [],
"parameters": {
"pageToken": {
"location": "query",
@@ -942,15 +1649,15 @@
"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",
- "location": "query"
+ "type": "integer"
},
"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",
- "location": "query"
+ "type": "string"
}
},
"scopes": [
@@ -963,32 +1670,32 @@
"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": {
- "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"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"parameters": {
"resource": {
- "description": "Resource name of the resource to attach the `Policy`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "Resource name of the resource to attach the `Policy`."
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}:setOrgPolicy",
+ "path": "v1/{+resource}:setOrgPolicy",
"id": "cloudresourcemanager.projects.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`."
},
"create": {
"httpMethod": "POST",
@@ -1009,49 +1716,215 @@
"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."
},
"listOrgPolicies": {
- "description": "Lists all the `Policies` set for a particular resource.",
- "request": {
- "$ref": "ListOrgPoliciesRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"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/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}:listOrgPolicies",
+ "path": "v1/{+resource}:listOrgPolicies",
"id": "cloudresourcemanager.projects.listOrgPolicies",
- "path": "v1/{+resource}:listOrgPolicies"
+ "description": "Lists all the `Policies` set for a particular resource.",
+ "request": {
+ "$ref": "ListOrgPoliciesRequest"
+ }
+ },
+ "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": "v1/projects/{projectId}",
+ "path": "v1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.get"
+ },
+ "getAncestry": {
+ "response": {
+ "$ref": "GetAncestryResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "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",
+ "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": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "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"
+ ],
+ "flatPath": "v1/projects/{resource}:testIamPermissions",
+ "id": "cloudresourcemanager.projects.testIamPermissions",
+ "path": "v1/projects/{resource}: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."
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "DELETE",
+ "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}",
+ "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": {
+ "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": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Name of the resource for the `Policy` to clear."
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}:clearOrgPolicy",
+ "id": "cloudresourcemanager.projects.clearOrgPolicy",
+ "path": "v1/{+resource}:clearOrgPolicy"
+ },
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "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"
+ ],
+ "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"
}
}
}
},
"parameters": {
+ "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"
},
- "uploadType": {
+ "callback": {
+ "type": "string",
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "description": "JSONP"
},
"$.xgafv": {
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1061,20 +1934,9 @@
"1",
"2"
],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "description": "V1 error format."
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -1083,49 +1945,54 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
},
"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.",
- "type": "string"
+ "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": {
+ "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.",
- "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": {
- "type": "boolean",
- "default": "true",
"location": "query",
- "description": "Pretty-print response."
+ "description": "Pretty-print response.",
+ "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"
},
- "bearer_token": {
+ "upload_protocol": {
"location": "query",
- "description": "OAuth bearer token.",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
- "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",
- "location": "query"
+ "default": "true"
}
},
"version": "v1",
@@ -1134,875 +2001,8 @@
"description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
"servicePath": "",
"basePath": "",
- "revision": "20171211",
+ "revision": "20171213",
"documentationLink": "https://cloud.google.com/resource-manager",
"id": "cloudresourcemanager:v1",
- "discoveryVersion": "v1",
- "schemas": {
- "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": {
- "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
- "type": "object",
- "properties": {
- "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."
- },
- "lifecycleState": {
- "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."
- ],
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED"
- ],
- "description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly"
- },
- "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"
- },
- "displayName": {
- "type": "string",
- "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"
- },
- "creationTime": {
- "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "Organization"
- },
- "ListAvailableOrgPolicyConstraintsResponse": {
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "Page token used to retrieve the next page. This is currently not used."
- },
- "constraints": {
- "description": "The collection of constraints that are settable on the request resource.",
- "type": "array",
- "items": {
- "$ref": "Constraint"
- }
- }
- },
- "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"
- },
- "ListPolicy": {
- "type": "object",
- "properties": {
- "allowedValues": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "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`."
- },
- "suggestedValue": {
- "type": "string",
- "description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Policy`. If `suggested_value`\nis not set, it will inherit the value specified higher in the hierarchy,\nunless `inherit_from_parent` is `false`."
- },
- "inheritFromParent": {
- "description": "Determines the inheritance behavior for this `Policy`.\n\nBy default, a `ListPolicy` set at a resource supercedes any `Policy` set\nanywhere up the resource hierarchy. However, if `inherit_from_parent` is\nset to `true`, then the values from the effective `Policy` of the parent\nresource are inherited, meaning the values set in this `Policy` are\nadded to the values inherited up the hierarchy.\n\nSetting `Policy` hierarchies that inherit both allowed values and denied\nvalues isn't recommended in most circumstances to keep the configuration\nsimple and understandable. However, it is possible to set a `Policy` with\n`allowed_values` set that inherits a `Policy` with `denied_values` set.\nIn this case, the values that are allowed must be in `allowed_values` and\nnot present in `denied_values`.\n\nFor example, suppose you have a `Constraint`\n`constraints/serviceuser.services`, which has a `constraint_type` of\n`list_constraint`, and with `constraint_default` set to `ALLOW`.\nSuppose that at the Organization level, a `Policy` is applied that\nrestricts the allowed API activations to {`E1`, `E2`}. Then, if a\n`Policy` is applied to a project below the Organization that has\n`inherit_from_parent` set to `false` and field all_values set to DENY,\nthen an attempt to activate any API will be denied.\n\nThe following examples demonstrate different possible layerings:\n\nExample 1 (no inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n ``projects/bar`` has `inherit_from_parent` `false` and values:\n {allowed_values: \"E3\" allowed_values: \"E4\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E3`, and `E4`.\n\nExample 2 (inherited values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n `projects/bar` has a `Policy` with values:\n {value: “E3” value: ”E4” inherit_from_parent: true}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.\n\nExample 3 (inheriting both allowed and denied values):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: \"E1\" allowed_values: \"E2\"}\n `projects/bar` has a `Policy` with:\n {denied_values: \"E1\"}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe value accepted at `projects/bar` is `E2`.\n\nExample 4 (RestoreDefault):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values:”E2”}\n `projects/bar` has a `Policy` with values:\n {RestoreDefault: {}}\nThe accepted values at `organizations/foo` are `E1`, `E2`.\nThe accepted values at `projects/bar` are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 5 (no policy inherits parent policy):\n `organizations/foo` has no `Policy` set.\n `projects/bar` has no `Policy` set.\nThe accepted values at both levels are either all or none depending on\nthe value of `constraint_default` (if `ALLOW`, all; if\n`DENY`, none).\n\nExample 6 (ListConstraint allowing all):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values: ”E2”}\n `projects/bar` has a `Policy` with:\n {all: ALLOW}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nAny value is accepted at `projects/bar`.\n\nExample 7 (ListConstraint allowing none):\n `organizations/foo` has a `Policy` with values:\n {allowed_values: “E1” allowed_values: ”E2”}\n `projects/bar` has a `Policy` with:\n {all: DENY}\nThe accepted values at `organizations/foo` are `E1`, E2`.\nNo value is accepted at `projects/bar`.",
- "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"
- }
- },
- "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": {
- "id": "GetAncestryResponse",
- "description": "Response from the GetAncestry method.",
- "type": "object",
- "properties": {
- "ancestor": {
- "description": "Ancestors are ordered from bottom to top of the resource hierarchy. The\nfirst ancestor is the project itself, followed by the project's parent,\netc.",
- "type": "array",
- "items": {
- "$ref": "Ancestor"
- }
- }
- }
- },
- "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": {
- "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"
- ]
- },
- "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"
- },
- "SearchOrganizationsRequest": {
- "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"
- },
- "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"
- }
- },
- "id": "SearchOrganizationsRequest",
- "description": "The request sent to the `SearchOrganizations` method."
- },
- "GetAncestryRequest": {
- "properties": {},
- "id": "GetAncestryRequest",
- "description": "The request sent to the\nGetAncestry\nmethod.",
- "type": "object"
- },
- "TestIamPermissionsRequest": {
- "id": "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"
- }
- }
- }
- },
- "FolderOperation": {
- "description": "Metadata describing a long running folder operation",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- },
- "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": {
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
- "type": "array",
- "items": {
- "$ref": "AuditConfig"
- }
- },
- "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."
- },
- "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": "Policy"
- },
- "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"
- },
- "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": {
- "id": {
- "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
- "type": "string"
- },
- "type": {
- "description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\"",
- "type": "string"
- }
- },
- "id": "ResourceId"
- },
- "GetEffectiveOrgPolicyRequest": {
- "description": "The request sent to the GetEffectiveOrgPolicy method.",
- "type": "object",
- "properties": {
- "constraint": {
- "type": "string",
- "description": "The name of the `Constraint` to compute the effective `Policy`."
- }
- },
- "id": "GetEffectiveOrgPolicyRequest"
- },
- "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": {
- "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"
- },
- "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."
- }
- },
- "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": {
- "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"
- },
- "Status": {
- "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",
- "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."
- },
- "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"
- },
- "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": {
- "version": {
- "type": "integer",
- "description": "Version of the `Constraint`. Default version is 0;",
- "format": "int32"
- },
- "listConstraint": {
- "$ref": "ListConstraint",
- "description": "Defines this constraint as being a ListConstraint."
- },
- "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"
- }
- },
- "id": "Constraint"
- },
- "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"
- },
- "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"
- },
- "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": {
- "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"
- },
- "UndeleteProjectRequest": {
- "description": "The request sent to the UndeleteProject\nmethod.",
- "type": "object",
- "properties": {},
- "id": "UndeleteProjectRequest"
- },
- "ProjectCreationStatus": {
- "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",
- "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"
- },
- "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": {
- "id": "GetIamPolicyRequest",
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {}
- },
- "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": "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.",
- "type": "object",
- "properties": {
- "directoryCustomerId": {
- "description": "The Google for Work customer id used in the Directory API.",
- "type": "string"
- }
- },
- "id": "OrganizationOwner"
- },
- "ListProjectsResponse": {
- "id": "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"
- }
- }
- },
- "Project": {
- "id": "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": {
- "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"
- },
- "createTime": {
- "type": "string",
- "description": "Creation time.\n\nRead-only.",
- "format": "google-datetime"
- },
- "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"
- },
- "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"
- }
- }
- },
- "ListOrgPoliciesResponse": {
- "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",
- "description": "The response returned from the ListOrgPolicies method. It will be empty\nif no `Policies` are set on the resource.",
- "type": "object"
- },
- "SearchOrganizationsResponse": {
- "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",
- "description": "The response returned from the `SearchOrganizations` method."
- },
- "FolderOperationError": {
- "description": "A classification of the Folder Operation error.",
- "type": "object",
- "properties": {
- "errorMessageId": {
- "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.",
- "type": "string"
- }
- },
- "id": "FolderOperationError"
- },
- "BooleanPolicy": {
- "description": "Used in `policy_type` to specify how `boolean_policy` will behave at this\nresource.",
- "type": "object",
- "properties": {
- "enforced": {
- "description": "If `true`, then the `Policy` is enforced. If `false`, then any\nconfiguration is acceptable.\n\nSuppose you have a `Constraint` `constraints/compute.disableSerialPortAccess`\nwith `constraint_default` set to `ALLOW`. A `Policy` for that\n`Constraint` exhibits the following behavior:\n - If the `Policy` at this resource has enforced set to `false`, serial\n port connection attempts will be allowed.\n - If the `Policy` at this resource has enforced set to `true`, serial\n port connection attempts will be refused.\n - If the `Policy` at this resource is `RestoreDefault`, serial port\n connection attempts will be allowed.\n - If no `Policy` is set at this resource or anywhere higher in the\n resource hierarchy, serial port connection attempts will be allowed.\n - If no `Policy` is set at this resource, but one exists higher in the\n resource hierarchy, the behavior is as if the`Policy` were set at\n this resource.\n\nThe following examples demonstrate the different possible layerings:\n\nExample 1 (nearest `Constraint` wins):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has no `Policy` set.\nThe constraint at `projects/bar` and `organizations/foo` will not be\nenforced.\n\nExample 2 (enforcement gets replaced):\n `organizations/foo` has a `Policy` with:\n {enforced: false}\n `projects/bar` has a `Policy` with:\n {enforced: true}\nThe constraint at `organizations/foo` is not enforced.\nThe constraint at `projects/bar` is enforced.\n\nExample 3 (RestoreDefault):\n `organizations/foo` has a `Policy` with:\n {enforced: true}\n `projects/bar` has a `Policy` with:\n {RestoreDefault: {}}\nThe constraint at `organizations/foo` is enforced.\nThe constraint at `projects/bar` is not enforced, because\n`constraint_default` for the `Constraint` is `ALLOW`.",
- "type": "boolean"
- }
- },
- "id": "BooleanPolicy"
- },
- "OrgPolicy": {
- "description": "Defines a Cloud Organization `Policy` which is used to specify `Constraints`\nfor configurations of Cloud Platform resources.",
- "type": "object",
- "properties": {
- "constraint": {
- "description": "The name of the `Constraint` the `Policy` is configuring, for example,\n`constraints/serviceuser.services`.\n\nImmutable after creation.",
- "type": "string"
- },
- "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.",
- "format": "google-datetime",
- "type": "string"
- },
- "version": {
- "description": "Version of the `Policy`. Default version is 0;",
- "format": "int32",
- "type": "integer"
- },
- "restoreDefault": {
- "$ref": "RestoreDefault",
- "description": "Restores the default behavior of the constraint; independent of\n`Constraint` type."
- },
- "listPolicy": {
- "description": "List of values either allowed or disallowed.",
- "$ref": "ListPolicy"
- },
- "etag": {
- "type": "string",
- "description": "An opaque tag indicating the current version of the `Policy`, used for\nconcurrency control.\n\nWhen the `Policy` is returned from either a `GetPolicy` or a\n`ListOrgPolicy` request, this `etag` indicates the version of the current\n`Policy` to use when executing a read-modify-write loop.\n\nWhen the `Policy` is returned from a `GetEffectivePolicy` request, the\n`etag` will be unset.\n\nWhen the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value\nthat was returned from a `GetOrgPolicy` request as part of a\nread-modify-write loop for concurrency control. Not setting the `etag`in a\n`SetOrgPolicy` request will result in an unconditional write of the\n`Policy`.",
- "format": "byte"
- }
- },
- "id": "OrgPolicy"
- },
- "Lien": {
- "description": "A Lien represents an encumbrance on the actions that can be performed on a\nresource.",
- "type": "object",
- "properties": {
- "parent": {
- "type": "string",
- "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`"
- },
- "createTime": {
- "description": "The creation time of this Lien.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "A system-generated unique identifier for this Lien.\n\nExample: `liens/1234abcd`",
- "type": "string"
- },
- "reason": {
- "type": "string",
- "description": "Concise user-visible strings indicating why an action cannot be performed\non a resource. Maximum lenth of 200 characters.\n\nExample: 'Holds production API key'"
- },
- "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"
- },
- "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"
- }
- }
- },
- "id": "Lien"
- },
- "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."
- },
- "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"
- },
- "SetOrgPolicyRequest": {
- "description": "The request sent to the SetOrgPolicyRequest method.",
- "type": "object",
- "properties": {
- "policy": {
- "$ref": "OrgPolicy",
- "description": "`Policy` to set on the resource."
- }
- },
- "id": "SetOrgPolicyRequest"
- },
- "SetIamPolicyRequest": {
- "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",
- "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",
- "canonicalName": "Cloud Resource Manager",
- "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"
- }
- }
- }
- },
- "rootUrl": "https://cloudresourcemanager.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudresourcemanager",
- "batchPath": "batch"
+ "discoveryVersion": "v1"
}
diff --git a/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json b/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
index 75f7838..ebd23bd 100644
--- a/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
@@ -1,127 +1,583 @@
{
- "schemas": {
- "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": {
- "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"
+ "canonicalName": "Cloud Resource Manager",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
},
- "projects": {
- "type": "array",
- "items": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://cloudresourcemanager.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudresourcemanager",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud Resource Manager API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "methods": {
+ "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",
+ "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": "v1beta1/projects/{projectId}",
+ "path": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.delete"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListProjectsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta1/projects",
+ "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."
+ },
+ "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"
+ ],
+ "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": "v1beta1/projects/{resource}:setIamPolicy",
+ "id": "cloudresourcemanager.projects.setIamPolicy",
+ "path": "v1beta1/projects/{resource}:setIamPolicy"
+ },
+ "create": {
+ "path": "v1beta1/projects",
+ "id": "cloudresourcemanager.projects.create",
+ "request": {
"$ref": "Project"
},
- "description": "The list of Projects that matched the list filter. This list can\nbe paginated."
- }
- },
- "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": {
- "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"
- },
- "GetAncestryRequest": {
- "type": "object",
- "properties": {},
- "id": "GetAncestryRequest",
- "description": "The request sent to the\nGetAncestry\nmethod."
- },
- "Project": {
- "type": "object",
- "properties": {
- "projectNumber": {
- "type": "string",
- "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
- "format": "int64"
- },
- "parent": {
- "$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."
- },
- "createTime": {
- "type": "string",
- "description": "Creation time.\n\nRead-only.",
- "format": "google-datetime"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
+ "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"
},
- "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": {
- "type": "string",
- "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."
- },
- "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": {
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED",
- "DELETE_IN_PROGRESS"
+ "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"
],
- "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 DeleteProject)\nor by the system (Google Cloud Platform).\nThis can generally be reversed by invoking UndeleteProject.",
- "This lifecycle state is no longer used and is not returned by the API."
+ "flatPath": "v1beta1/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.",
+ "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",
+ "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"
+ },
+ "get": {
+ "path": "v1beta1/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.",
+ "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": {
+ "location": "path",
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}"
+ },
+ "undelete": {
+ "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.",
+ "request": {
+ "$ref": "UndeleteProjectRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "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}:undelete",
+ "path": "v1beta1/projects/{projectId}:undelete",
+ "id": "cloudresourcemanager.projects.undelete"
+ },
+ "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"
+ },
+ "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": "v1beta1/projects/{projectId}",
+ "path": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.update"
+ },
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "GetAncestryResponse"
+ },
+ "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": "v1beta1/projects/{projectId}:getAncestry",
+ "id": "cloudresourcemanager.projects.getAncestry",
+ "path": "v1beta1/projects/{projectId}:getAncestry"
+ },
+ "testIamPermissions": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta1/projects/{resource}:testIamPermissions",
+ "path": "v1beta1/projects/{resource}:testIamPermissions",
+ "id": "cloudresourcemanager.projects.testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified Project."
+ }
+ }
+ },
+ "organizations": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListOrganizationsResponse"
+ },
+ "parameters": {
+ "pageSize": {
+ "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "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 `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",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A pagination token returned from a previous call to `ListOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta1/organizations",
+ "id": "cloudresourcemanager.organizations.list",
+ "path": "v1beta1/organizations",
+ "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."
+ },
+ "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"
+ },
+ "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"
+ },
+ "getIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "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",
+ "id": "cloudresourcemanager.organizations.getIamPolicy",
+ "path": "v1beta1/{+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\"."
+ },
+ "get": {
+ "flatPath": "v1beta1/organizations/{organizationsId}",
+ "id": "cloudresourcemanager.organizations.get",
+ "path": "v1beta1/{+name}",
+ "description": "Fetches an Organization resource identified by the specified resource name.",
+ "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": {
+ "location": "path",
+ "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
]
- }
- },
- "id": "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."
- },
- "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).",
- "type": "array",
- "items": {
- "type": "string"
+ },
+ "update": {
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
}
+ },
+ "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\".",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "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/organizations/{organizationsId}:testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "cloudresourcemanager.organizations.testIamPermissions"
}
- },
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method."
+ }
+ }
+ },
+ "parameters": {
+ "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": {
+ "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": {
+ "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": {
+ "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": "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": "",
+ "revision": "20171211",
+ "documentationLink": "https://cloud.google.com/resource-manager",
+ "id": "cloudresourcemanager:v1beta1",
+ "discoveryVersion": "v1",
+ "schemas": {
"Policy": {
- "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.",
@@ -134,31 +590,26 @@
"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.",
"type": "array",
"items": {
"$ref": "Binding"
- },
- "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error."
+ }
}
},
"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)."
+ "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"
},
"FolderOperation": {
- "description": "Metadata describing a long running folder operation",
- "type": "object",
"properties": {
- "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": {
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
@@ -180,16 +631,21 @@
"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"
+ "id": "FolderOperation",
+ "description": "Metadata describing a long running folder operation",
+ "type": "object"
},
"FolderOperationError": {
"description": "A classification of the Folder Operation error.",
"type": "object",
"properties": {
"errorMessageId": {
- "type": "string",
"enumDescriptions": [
"The error type was unrecognized or unspecified.",
"The attempted action would violate the max folder depth constraint.",
@@ -214,28 +670,28 @@
"FOLDER_TO_DELETE_NON_EMPTY_VIOLATION",
"DELETED_FOLDER_HEIGHT_VIOLATION"
],
- "description": "The type of operation error experienced."
+ "description": "The type of operation error experienced.",
+ "type": "string"
}
},
"id": "FolderOperationError"
},
"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": {
- "type": "string",
- "description": "Required field representing the resource type this id is for.\nAt present, the valid types are \"project\", \"folder\", and \"organization\"."
+ "description": "Required field representing the resource type this id is for.\nAt present, the valid types are \"project\", \"folder\", and \"organization\".",
+ "type": "string"
},
"id": {
- "type": "string",
- "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's."
+ "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",
- "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."
+ "id": "ResourceId"
},
"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.",
@@ -250,9 +706,11 @@
}
},
"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."
+ "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"
},
"Ancestor": {
+ "description": "Identifying information for a single ancestor of a project.",
"type": "object",
"properties": {
"resourceId": {
@@ -260,10 +718,26 @@
"description": "Resource id of the ancestor."
}
},
- "id": "Ancestor",
- "description": "Identifying information for a single ancestor of a project."
+ "id": "Ancestor"
+ },
+ "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"
},
"ListOrganizationsResponse": {
+ "description": "The response returned from the `ListOrganizations` method.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -278,39 +752,22 @@
}
}
},
- "id": "ListOrganizationsResponse",
- "description": "The response returned from the `ListOrganizations` method."
- },
- "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": {
- "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",
- "description": "Request message for `SetIamPolicy` method."
+ "id": "ListOrganizationsResponse"
},
"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"
- },
"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": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
}
},
"id": "Binding"
@@ -321,24 +778,13 @@
"properties": {},
"id": "Empty"
},
- "UndeleteProjectRequest": {
- "type": "object",
- "properties": {},
- "id": "UndeleteProjectRequest",
- "description": "The request sent to the UndeleteProject\nmethod."
- },
"Organization": {
"description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
"type": "object",
"properties": {
- "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"
},
"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\".",
@@ -349,52 +795,57 @@
"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",
- "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."
- ]
+ "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"
}
},
"id": "Organization"
},
+ "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": {
- "type": "boolean",
- "description": "True if the project creation process is complete."
+ "description": "True if the project creation process is complete.",
+ "type": "boolean"
},
"createTime": {
- "type": "string",
"description": "Creation time of the project creation workflow.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"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."
+ "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"
},
- "GetIamPolicyRequest": {
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest",
- "description": "Request message for `GetIamPolicy` method."
- },
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
@@ -409,7 +860,14 @@
},
"id": "TestIamPermissionsResponse"
},
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
+ },
"GetAncestryResponse": {
+ "description": "Response from the GetAncestry method.",
"type": "object",
"properties": {
"ancestor": {
@@ -420,601 +878,143 @@
}
}
},
- "id": "GetAncestryResponse",
- "description": "Response from the GetAncestry method."
+ "id": "GetAncestryResponse"
},
"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": {
- "type": "string",
- "description": "The Google for Work customer id used in the Directory API."
+ "description": "The Google for Work customer id used in the Directory API.",
+ "type": "string"
}
},
"id": "OrganizationOwner"
+ },
+ "ListProjectsResponse": {
+ "properties": {
+ "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"
+ },
+ "projects": {
+ "description": "The list of Projects that matched the list filter. This list can\nbe paginated.",
+ "type": "array",
+ "items": {
+ "$ref": "Project"
+ }
+ }
+ },
+ "id": "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"
+ },
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "id": "AuditLogConfig"
+ },
+ "GetAncestryRequest": {
+ "description": "The request sent to the\nGetAncestry\nmethod.",
+ "type": "object",
+ "properties": {},
+ "id": "GetAncestryRequest"
+ },
+ "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": {
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED",
+ "DELETE_IN_PROGRESS"
+ ],
+ "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 DeleteProject)\nor by the system (Google Cloud Platform).\nThis can generally be reversed by invoking UndeleteProject.",
+ "This lifecycle state is no longer used and is not returned by the API."
+ ]
+ },
+ "projectNumber": {
+ "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
+ "format": "int64",
+ "type": "string"
+ },
+ "parent": {
+ "$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": {
+ "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"
+ }
+ },
+ "id": "Project"
+ },
+ "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"
}
},
"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 Resource Manager",
- "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"
- }
- }
- }
- },
- "rootUrl": "https://cloudresourcemanager.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudresourcemanager",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Resource Manager API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "methods": {
- "undelete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The project ID (for example, `foo-bar-123`).\n\nRequired."
- }
- },
- "flatPath": "v1beta1/projects/{projectId}:undelete",
- "path": "v1beta1/projects/{projectId}:undelete",
- "id": "cloudresourcemanager.projects.undelete",
- "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.",
- "request": {
- "$ref": "UndeleteProjectRequest"
- }
- },
- "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": {
- "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",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/projects/{projectId}",
- "path": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.get"
- },
- "getAncestry": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "GetAncestryResponse"
- },
- "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",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/projects/{projectId}:getAncestry",
- "id": "cloudresourcemanager.projects.getAncestry",
- "path": "v1beta1/projects/{projectId}: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."
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "projectId"
- ],
- "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"
- ],
- "flatPath": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.update",
- "path": "v1beta1/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."
- },
- "testIamPermissions": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Project.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "required": true,
- "type": "string",
- "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"
- ],
- "flatPath": "v1beta1/projects/{resource}:testIamPermissions",
- "id": "cloudresourcemanager.projects.testIamPermissions",
- "path": "v1beta1/projects/{resource}:testIamPermissions"
- },
- "delete": {
- "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": "v1beta1/projects/{projectId}",
- "path": "v1beta1/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, 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."
- },
- "list": {
- "response": {
- "$ref": "ListProjectsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "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": {
- "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"
- },
- "filter": {
- "type": "string",
- "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."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/projects",
- "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."
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Project"
- },
- "parameters": {
- "useLegacyStack": {
- "location": "query",
- "description": "A safety hatch to opt out of the new reliable project creation process.",
- "type": "boolean"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects",
- "id": "cloudresourcemanager.projects.create",
- "path": "v1beta1/projects",
- "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."
- },
- "setIamPolicy": {
- "flatPath": "v1beta1/projects/{resource}:setIamPolicy",
- "id": "cloudresourcemanager.projects.setIamPolicy",
- "path": "v1beta1/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()`; 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"
- ],
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy 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"
- ],
- "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."
- }
- }
- },
- "organizations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListOrganizationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "A pagination token returned from a previous call to `ListOrganizations`\nthat indicates from where listing should continue.\nThis field is optional."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
- "format": "int32"
- },
- "filter": {
- "type": "string",
- "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."
- }
- },
- "flatPath": "v1beta1/organizations",
- "path": "v1beta1/organizations",
- "id": "cloudresourcemanager.organizations.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."
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "required": true,
- "type": "string",
- "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."
- }
- },
- "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": {
- "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": "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": {
- "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": {
- "organizationId": {
- "location": "query",
- "description": "The id of the Organization resource to fetch.\nThis field is deprecated and will be removed in v1. Use name instead.",
- "type": "string"
- },
- "name": {
- "location": "path",
- "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$"
- }
- },
- "flatPath": "v1beta1/organizations/{organizationsId}",
- "path": "v1beta1/{+name}",
- "id": "cloudresourcemanager.organizations.get"
- },
- "update": {
- "description": "Updates an Organization resource identified by the specified resource name.",
- "request": {
- "$ref": "Organization"
- },
- "response": {
- "$ref": "Organization"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- },
- "testIamPermissions": {
- "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\".",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "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"
- ]
- }
- }
- }
- },
- "parameters": {
- "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": {
- "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."
- },
- "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": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Pretty-print response."
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "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": {
- "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"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
- }
- },
- "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": "",
- "revision": "20171213",
- "documentationLink": "https://cloud.google.com/resource-manager",
- "id": "cloudresourcemanager:v1beta1",
- "discoveryVersion": "v1"
+ "protocol": "rest"
}
diff --git a/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json b/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
index 5679a87..8583949 100644
--- a/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
@@ -1,438 +1,219 @@
{
- "canonicalName": "Cloud Resource Manager",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
+ "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"
},
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
+ "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"
}
- }
- }
- },
- "rootUrl": "https://cloudresourcemanager.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudresourcemanager",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Cloud Resource Manager API",
- "ownerName": "Google",
- "resources": {
- "folders": {
- "methods": {
- "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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The resource name of the Folder to move.\nMust be of the form folders/{folder_id}",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/folders/{foldersId}:move",
- "path": "v2beta1/{+name}:move",
- "id": "cloudresourcemanager.folders.move"
- },
- "testIamPermissions": {
- "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": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/folders/{foldersId}:testIamPermissions",
- "path": "v2beta1/{+resource}:testIamPermissions",
- "id": "cloudresourcemanager.folders.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"
- },
- "delete": {
- "parameters": {
- "name": {
- "description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/folders/{foldersId}",
- "id": "cloudresourcemanager.folders.delete",
- "path": "v2beta1/{+name}",
- "description": "Requests deletion of a Folder. The Folder is moved into the\nDELETE_REQUESTED state\nimmediately, and is deleted approximately 30 days later. This method may\nonly be called on an empty Folder in the\nACTIVE state, where a Folder is empty if\nit doesn't contain any Folders or Projects in the\nACTIVE state.\nThe caller must have `resourcemanager.folders.delete` permission on the\nidentified folder.",
- "httpMethod": "DELETE",
- "response": {
+ },
+ "id": "SetIamPolicyRequest"
+ },
+ "SearchFoldersResponse": {
+ "description": "The response message for searching folders.",
+ "type": "object",
+ "properties": {
+ "folders": {
+ "description": "A possibly paginated folder search results.\nthe specified parent resource.",
+ "type": "array",
+ "items": {
"$ref": "Folder"
- },
- "parameterOrder": [
- "name"
+ }
+ },
+ "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"
+ },
+ "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": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "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": {
+ "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\".|",
+ "type": "string"
+ }
+ },
+ "id": "SearchFoldersRequest"
+ },
+ "ProjectCreationStatus": {
+ "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",
+ "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"
+ },
+ "Folder": {
+ "description": "A Folder in an Organization's resource hierarchy, used to\norganize that Organization's resources.",
+ "type": "object",
+ "properties": {
+ "createTime": {
+ "description": "Output only. Timestamp when the Folder was created. Assigned by the server.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "lifecycleState": {
+ "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",
+ "enumDescriptions": [
+ "Unspecified state.",
+ "The normal and active state.",
+ "The folder has been marked for deletion by the user."
]
},
- "list": {
- "path": "v2beta1/folders",
- "id": "cloudresourcemanager.folders.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.",
- "response": {
- "$ref": "ListFoldersResponse"
- },
- "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"
- },
- "showDeleted": {
- "description": "Controls whether Folders in the\nDELETE_REQUESTED\nstate should be returned.",
- "type": "boolean",
- "location": "query"
- },
- "pageToken": {
- "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates where this listing should continue from.\nThis field is optional.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of Folders to return in the response.\nThis field is optional.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v2beta1/folders"
+ "name": {
+ "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".",
+ "type": "string"
},
- "create": {
- "id": "cloudresourcemanager.folders.create",
- "path": "v2beta1/folders",
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/folders"
+ "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"
},
- "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": "^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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- }
- },
- "getIamPolicy": {
- "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.",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "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": {
- "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/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/folders/{foldersId}:getIamPolicy",
- "path": "v2beta1/{+resource}:getIamPolicy",
- "id": "cloudresourcemanager.folders.getIamPolicy"
- },
- "search": {
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v2beta1/folders:search",
- "id": "cloudresourcemanager.folders.search",
- "path": "v2beta1/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`.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchFoldersResponse"
- }
- },
- "undelete": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Folder"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/folders/{foldersId}:undelete",
- "id": "cloudresourcemanager.folders.undelete",
- "path": "v2beta1/{+name}: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"
- }
- },
- "get": {
- "response": {
- "$ref": "Folder"
- },
- "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 Folder to retrieve.\nMust be of the form `folders/{folder_id}`.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "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."
- },
- "patch": {
- "id": "cloudresourcemanager.folders.patch",
- "path": "v2beta1/{+name}",
- "request": {
- "$ref": "Folder"
- },
- "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.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Folder"
- },
- "parameters": {
- "updateMask": {
- "description": "Fields to be updated.\nOnly the `display_name` can be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "name": {
- "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/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/folders/{foldersId}"
+ "parent": {
+ "description": "The Folder’s parent's resource name.\nUpdates to the folder's parent must be performed via\nMoveFolder.",
+ "type": "string"
}
- }
- }
- },
- "parameters": {
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
+ },
+ "id": "Folder"
},
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
+ "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"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "UndeleteFolderRequest": {
+ "description": "The UndeleteFolder request message.",
+ "type": "object",
+ "properties": {},
+ "id": "UndeleteFolderRequest"
},
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
+ "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"
},
- "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"
- },
- "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"
- }
- },
- "version": "v2beta1",
- "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": "",
- "documentationLink": "https://cloud.google.com/resource-manager",
- "revision": "20171211",
- "id": "cloudresourcemanager:v2beta1",
- "discoveryVersion": "v1",
- "schemas": {
"TestIamPermissionsRequest": {
- "id": "TestIamPermissionsRequest",
"description": "Request message for `TestIamPermissions` method.",
"type": "object",
"properties": {
@@ -443,7 +224,72 @@
"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).",
+ "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"
+ }
+ }
+ },
+ "id": "Policy"
+ },
+ "FolderOperation": {
+ "description": "Metadata describing a long running folder operation",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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.",
@@ -480,127 +326,60 @@
},
"id": "FolderOperationError"
},
- "FolderOperation": {
- "id": "FolderOperation",
- "description": "Metadata describing a long running folder operation",
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
- "displayName": {
- "description": "The display name of the folder.",
- "type": "string"
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
},
- "sourceParent": {
- "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
- "type": "string"
+ "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"
},
- "destinationParent": {
- "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
- "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"
},
- "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"
- }
- }
- },
- "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"
+ "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"
}
},
- "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",
+ "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"
},
"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"
}
- },
- "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"
}
- }
- },
- "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": {
- "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": "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"
},
"ListFoldersResponse": {
- "id": "ListFoldersResponse",
- "description": "The ListFolders response message.",
- "type": "object",
"properties": {
"folders": {
"description": "A possibly paginated list of Folders that are direct descendants of\nthe specified parent resource.",
@@ -613,7 +392,10 @@
"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",
+ "description": "The ListFolders response message.",
+ "type": "object"
},
"MoveFolderRequest": {
"description": "The MoveFolder request message.",
@@ -625,224 +407,442 @@
}
},
"id": "MoveFolderRequest"
- },
- "SearchFoldersResponse": {
- "id": "SearchFoldersResponse",
- "description": "The response message for searching folders.",
- "type": "object",
- "properties": {
- "folders": {
- "description": "A possibly paginated folder search results.\nthe specified parent resource.",
- "type": "array",
- "items": {
- "$ref": "Folder"
- }
- },
- "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"
- }
- }
- },
- "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"
- },
- "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"
- },
- "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"
- }
- }
- }
- }
- },
- "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"
- }
- }
- },
- "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": {
- "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\".|",
- "type": "string"
- }
- },
- "id": "SearchFoldersRequest"
- },
- "Folder": {
- "id": "Folder",
- "description": "A Folder in an Organization's resource hierarchy, used to\norganize that Organization's resources.",
- "type": "object",
- "properties": {
- "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"
- },
- "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": {
- "description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\nDeleteFolder and\nUndeleteFolder.",
- "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"
- ]
- }
- }
- },
- "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"
- },
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
- },
- "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"
- }
- }
- }
- },
- "UndeleteFolderRequest": {
- "id": "UndeleteFolderRequest",
- "description": "The UndeleteFolder request message.",
- "type": "object",
- "properties": {}
- },
- "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",
- "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"
- }
- }
}
},
"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"
+ "protocol": "rest",
+ "canonicalName": "Cloud Resource Manager",
+ "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"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://cloudresourcemanager.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudresourcemanager",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud Resource Manager API",
+ "ownerName": "Google",
+ "resources": {
+ "folders": {
+ "methods": {
+ "create": {
+ "id": "cloudresourcemanager.folders.create",
+ "path": "v2beta1/folders",
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "parent": {
+ "description": "The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/folders"
+ },
+ "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.",
+ "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": "^folders/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/folders/{foldersId}:setIamPolicy"
+ },
+ "getIamPolicy": {
+ "path": "v2beta1/{+resource}:getIamPolicy",
+ "id": "cloudresourcemanager.folders.getIamPolicy",
+ "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.",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "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": {
+ "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/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/folders/{foldersId}:getIamPolicy"
+ },
+ "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`.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchFoldersResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v2beta1/folders:search",
+ "id": "cloudresourcemanager.folders.search",
+ "path": "v2beta1/folders:search"
+ },
+ "patch": {
+ "response": {
+ "$ref": "Folder"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "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": {
+ "pattern": "^folders/[^/]+$",
+ "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"
+ }
+ },
+ "flatPath": "v2beta1/folders/{foldersId}",
+ "path": "v2beta1/{+name}",
+ "id": "cloudresourcemanager.folders.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"
+ }
+ },
+ "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.",
+ "response": {
+ "$ref": "Folder"
+ },
+ "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 resource name of the Folder to retrieve.\nMust be of the form `folders/{folder_id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/folders/{foldersId}",
+ "path": "v2beta1/{+name}",
+ "id": "cloudresourcemanager.folders.get"
+ },
+ "undelete": {
+ "response": {
+ "$ref": "Folder"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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": {
+ "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"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the Folder to move.\nMust be of the form folders/{folder_id}",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/folders/{foldersId}:move",
+ "path": "v2beta1/{+name}:move",
+ "id": "cloudresourcemanager.folders.move"
+ },
+ "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.",
+ "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": "^folders/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/folders/{foldersId}:testIamPermissions",
+ "id": "cloudresourcemanager.folders.testIamPermissions",
+ "path": "v2beta1/{+resource}:testIamPermissions"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Folder"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/folders/{foldersId}",
+ "path": "v2beta1/{+name}",
+ "id": "cloudresourcemanager.folders.delete",
+ "description": "Requests deletion of a Folder. The Folder is moved into the\nDELETE_REQUESTED state\nimmediately, and is deleted approximately 30 days later. This method may\nonly be called on an empty Folder in the\nACTIVE state, where a Folder is empty if\nit doesn't contain any Folders or Projects in the\nACTIVE state.\nThe caller must have `resourcemanager.folders.delete` permission on the\nidentified folder."
+ },
+ "list": {
+ "flatPath": "v2beta1/folders",
+ "path": "v2beta1/folders",
+ "id": "cloudresourcemanager.folders.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.",
+ "response": {
+ "$ref": "ListFoldersResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "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"
+ },
+ "showDeleted": {
+ "location": "query",
+ "description": "Controls whether Folders in the\nDELETE_REQUESTED\nstate should be returned.",
+ "type": "boolean"
+ },
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates where this listing should continue from.\nThis field is optional.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of Folders to return in the response.\nThis field is optional.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "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"
+ },
+ "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": "v2beta1",
+ "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": "",
+ "id": "cloudresourcemanager:v2beta1",
+ "revision": "20171211",
+ "documentationLink": "https://cloud.google.com/resource-manager",
+ "discoveryVersion": "v1"
}
diff --git a/cloudshell/v1/cloudshell-api.json b/cloudshell/v1/cloudshell-api.json
index 0135bad..93978b5 100644
--- a/cloudshell/v1/cloudshell-api.json
+++ b/cloudshell/v1/cloudshell-api.json
@@ -1,92 +1,4 @@
{
- "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": {
- "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"
- },
- "$.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": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "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": {
- "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": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- }
- },
"version": "v1",
"baseUrl": "https://cloudshell.googleapis.com/",
"kind": "discovery#restDescription",
@@ -99,11 +11,101 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "StartEnvironmentMetadata": {
- "description": "Message included in the metadata field of operations returned from\nStartEnvironment.",
+ "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": {
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "type": "object"
+ },
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Status"
+ },
+ "PublicKey": {
+ "id": "PublicKey",
+ "description": "A public SSH key, corresponding to a private SSH key held by the client.",
+ "type": "object",
+ "properties": {
+ "format": {
+ "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",
+ "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)."
+ ]
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "type": "object",
+ "properties": {},
+ "id": "CancelOperationRequest",
+ "description": "The request message for Operations.CancelOperation."
+ },
+ "StartEnvironmentMetadata": {
+ "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",
@@ -111,53 +113,50 @@
"FINISHED"
],
"description": "Current state of the environment being started.",
- "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."
- ]
+ "type": "string"
}
},
- "id": "StartEnvironmentMetadata"
+ "id": "StartEnvironmentMetadata",
+ "description": "Message included in the metadata field of operations returned from\nStartEnvironment.",
+ "type": "object"
},
"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": {
- "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."
+ "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"
},
"ListOperationsResponse": {
+ "id": "ListOperationsResponse",
"description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
@@ -172,8 +171,7 @@
"$ref": "Operation"
}
}
- },
- "id": "ListOperationsResponse"
+ }
},
"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\".",
@@ -204,9 +202,9 @@
"type": "string"
},
"sshPort": {
+ "type": "integer",
"description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"id": {
"description": "Output only. The environment's identifier, which is always \"default\".",
@@ -229,98 +227,12 @@
}
},
"id": "Environment"
- },
- "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": {
- "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": {
- "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"
- }
- }
- },
- "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": {
- "type": "string",
- "description": "Required. Content of this key.",
- "format": "byte"
- },
- "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"
- },
- "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"
}
},
"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 Shell",
"auth": {
@@ -343,6 +255,10 @@
"operations": {
"methods": {
"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"
},
@@ -364,13 +280,12 @@
],
"flatPath": "v1/operations/{operationsId}:cancel",
"path": "v1/{+name}:cancel",
- "id": "cloudshell.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`."
+ "id": "cloudshell.operations.cancel"
},
"delete": {
+ "id": "cloudshell.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"
@@ -380,22 +295,22 @@
},
"parameters": {
"name": {
+ "location": "path",
"description": "The name of the operation resource to be deleted.",
"required": true,
"type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
+ "pattern": "^operations/.+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/operations/{operationsId}",
- "id": "cloudshell.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`."
+ "flatPath": "v1/operations/{operationsId}"
},
"list": {
+ "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.",
"response": {
"$ref": "ListOperationsResponse"
@@ -408,37 +323,32 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"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 standard list page size.",
- "format": "int32",
- "type": "integer",
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
"location": "query"
},
- "filter": {
+ "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"
+ },
+ "pageSize": {
"location": "query",
- "description": "The standard list filter.",
- "type": "string"
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
}
- },
- "flatPath": "v1/operations",
- "path": "v1/{+name}",
- "id": "cloudshell.operations.list"
+ }
},
"get": {
- "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"
@@ -459,9 +369,99 @@
"location": "path"
}
},
- "flatPath": "v1/operations/{operationsId}"
+ "flatPath": "v1/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "cloudshell.operations.get"
}
}
}
+ },
+ "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": {
+ "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": {
+ "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": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 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",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ }
}
}
diff --git a/cloudshell/v1alpha1/cloudshell-api.json b/cloudshell/v1alpha1/cloudshell-api.json
index 631673c..a659596 100644
--- a/cloudshell/v1alpha1/cloudshell-api.json
+++ b/cloudshell/v1alpha1/cloudshell-api.json
@@ -1,264 +1,7 @@
{
- "rootUrl": "https://cloudshell.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudshell",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Cloud Shell API",
- "ownerName": "Google",
- "resources": {
- "users": {
- "resources": {
- "environments": {
- "methods": {
- "start": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "pattern": "^users/[^/]+/environments/[^/]+$",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}:start",
- "id": "cloudshell.users.environments.start",
- "path": "v1alpha1/{+name}: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",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Environment"
- },
- "parameters": {
- "name": {
- "description": "Name of the requested resource, for example `users/me/environments/default`\nor `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}",
- "id": "cloudshell.users.environments.get",
- "path": "v1alpha1/{+name}"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Environment"
- },
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "Mask specifying which fields in the environment should be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "pattern": "^users/[^/]+/environments/[^/]+$",
- "location": "path",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}",
- "id": "cloudshell.users.environments.patch",
- "path": "v1alpha1/{+name}",
- "request": {
- "$ref": "Environment"
- },
- "description": "Updates an existing environment."
- }
- },
- "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": {
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+/environments/[^/]+/publicKeys/[^/]+$",
- "location": "path",
- "description": "Name of the resource to be deleted, e.g.\n`users/me/environments/default/publicKeys/my-key`."
- }
- },
- "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys/{publicKeysId}",
- "path": "v1alpha1/{+name}",
- "id": "cloudshell.users.environments.publicKeys.delete"
- },
- "create": {
- "request": {
- "$ref": "CreatePublicKeyRequest"
- },
- "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.",
- "response": {
- "$ref": "PublicKey"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Parent resource name, e.g. `users/me/environments/default`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+/environments/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys",
- "path": "v1alpha1/{+parent}/publicKeys",
- "id": "cloudshell.users.environments.publicKeys.create"
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "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": {
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
- },
- "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",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- }
- },
- "version": "v1alpha1",
- "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": "",
- "revision": "20171213",
- "documentationLink": "https://cloud.google.com/shell/docs/",
"id": "cloudshell:v1alpha1",
+ "documentationLink": "https://cloud.google.com/shell/docs/",
+ "revision": "20171213",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
@@ -267,11 +10,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": {
- "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"
@@ -280,12 +18,17 @@
"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"
}
}
},
@@ -294,8 +37,8 @@
"type": "object",
"properties": {
"environment": {
- "$ref": "Environment",
- "description": "Environment that was started."
+ "description": "Environment that was started.",
+ "$ref": "Environment"
}
},
"id": "StartEnvironmentResponse"
@@ -306,12 +49,16 @@
"type": "object",
"properties": {}
},
- "PublicKey": {
- "id": "PublicKey",
- "description": "A public SSH key, corresponding to a private SSH key held by the client.",
+ "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": {
"properties": {
"format": {
+ "type": "string",
"enumDescriptions": [
"Unknown format. Do not use.",
"`ssh-dss` key format (see RFC4253).",
@@ -328,66 +75,60 @@
"ECDSA_SHA2_NISTP384",
"ECDSA_SHA2_NISTP521"
],
- "description": "Required. Format of this key's content.",
- "type": "string"
+ "description": "Required. Format of this key's content."
},
"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": {
- "type": "string",
"description": "Required. Content of this key.",
- "format": "byte"
+ "format": "byte",
+ "type": "string"
}
- }
- },
- "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 `{}`."
+ },
+ "id": "PublicKey",
+ "description": "A public SSH key, corresponding to a private SSH key held by the client.",
+ "type": "object"
},
"StartEnvironmentMetadata": {
"description": "Message included in the metadata field of operations returned from\nStartEnvironment.",
"type": "object",
"properties": {
"state": {
- "enum": [
- "STATE_UNSPECIFIED",
- "STARTING",
- "UNARCHIVING_DISK",
- "FINISHED"
- ],
- "description": "Current state of the environment being started.",
"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": {
+ "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": {
+ "type": "object",
"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."
},
- "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"
},
"response": {
"additionalProperties": {
@@ -400,15 +141,15 @@
"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."
}
},
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object"
+ "id": "Operation"
},
"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": {
"state": {
"enum": [
@@ -444,8 +185,8 @@
"type": "string"
},
"sshUsername": {
- "description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment.",
- "type": "string"
+ "type": "string",
+ "description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment."
},
"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.",
@@ -455,29 +196,31 @@
}
},
"dockerImage": {
- "type": "string",
- "description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\"."
+ "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"
}
},
- "id": "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"
},
"CreatePublicKeyRequest": {
- "id": "CreatePublicKeyRequest",
"description": "Request message for CreatePublicKey.",
"type": "object",
"properties": {
"key": {
- "description": "Key that should be added to the environment.",
- "$ref": "PublicKey"
+ "$ref": "PublicKey",
+ "description": "Key that should be added to the environment."
}
- }
+ },
+ "id": "CreatePublicKeyRequest"
}
},
- "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": "Cloud Shell",
"auth": {
"oauth2": {
@@ -487,5 +230,262 @@
}
}
}
- }
+ },
+ "rootUrl": "https://cloudshell.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudshell",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Cloud Shell API",
+ "ownerName": "Google",
+ "resources": {
+ "users": {
+ "resources": {
+ "environments": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "Environment"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^users/[^/]+/environments/[^/]+$",
+ "location": "path",
+ "description": "Name of the requested resource, for example `users/me/environments/default`\nor `users/someone@example.com/environments/default`."
+ }
+ },
+ "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}",
+ "path": "v1alpha1/{+name}",
+ "id": "cloudshell.users.environments.get",
+ "description": "Gets an environment. Returns NOT_FOUND if the environment does not exist."
+ },
+ "patch": {
+ "request": {
+ "$ref": "Environment"
+ },
+ "description": "Updates an existing environment.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Environment"
+ },
+ "parameters": {
+ "updateMask": {
+ "description": "Mask specifying which fields in the environment should be updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "pattern": "^users/[^/]+/environments/[^/]+$",
+ "location": "path",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}",
+ "id": "cloudshell.users.environments.patch",
+ "path": "v1alpha1/{+name}"
+ },
+ "start": {
+ "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}:start",
+ "id": "cloudshell.users.environments.start",
+ "path": "v1alpha1/{+name}:start",
+ "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.",
+ "request": {
+ "$ref": "StartEnvironmentRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^users/[^/]+/environments/[^/]+$",
+ "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"
+ }
+ }
+ }
+ },
+ "resources": {
+ "publicKeys": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "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/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys/{publicKeysId}",
+ "path": "v1alpha1/{+name}",
+ "id": "cloudshell.users.environments.publicKeys.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."
+ },
+ "create": {
+ "path": "v1alpha1/{+parent}/publicKeys",
+ "id": "cloudshell.users.environments.publicKeys.create",
+ "request": {
+ "$ref": "CreatePublicKeyRequest"
+ },
+ "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.",
+ "response": {
+ "$ref": "PublicKey"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "pattern": "^users/[^/]+/environments/[^/]+$",
+ "location": "path",
+ "description": "Parent resource name, e.g. `users/me/environments/default`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "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": {
+ "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"
+ },
+ "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": "v1alpha1",
+ "baseUrl": "https://cloudshell.googleapis.com/",
+ "servicePath": "",
+ "kind": "discovery#restDescription",
+ "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n",
+ "basePath": ""
}
diff --git a/cloudtasks/v2beta2/cloudtasks-api.json b/cloudtasks/v2beta2/cloudtasks-api.json
index 3a2b7ab..206807c 100644
--- a/cloudtasks/v2beta2/cloudtasks-api.json
+++ b/cloudtasks/v2beta2/cloudtasks-api.json
@@ -1,7 +1,4 @@
{
- "rootUrl": "https://cloudtasks.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "cloudtasks",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Cloud Tasks API",
@@ -12,8 +9,6 @@
"locations": {
"methods": {
"list": {
- "path": "v2beta2/{+name}/locations",
- "id": "cloudtasks.projects.locations.list",
"description": "Lists information about the supported locations for this service.",
"response": {
"$ref": "ListLocationsResponse"
@@ -22,35 +17,37 @@
"name"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
"name": {
- "pattern": "^projects/[^/]+$",
"location": "path",
"description": "The resource that owns the locations collection, if applicable.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
},
"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"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
}
},
- "flatPath": "v2beta2/projects/{projectsId}/locations"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations",
+ "path": "v2beta2/{+name}/locations",
+ "id": "cloudtasks.projects.locations.list"
},
"get": {
"description": "Get information about a location.",
@@ -63,11 +60,11 @@
"httpMethod": "GET",
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path",
"description": "Resource name for the location.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
}
},
"scopes": [
@@ -81,80 +78,80 @@
"resources": {
"queues": {
"methods": {
- "get": {
- "description": "Gets a queue.",
+ "patch": {
"response": {
"$ref": "Queue"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"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": {
- "description": "Required.\n\nThe resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`",
+ "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/[^/]+$",
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
"path": "v2beta2/{+name}",
- "id": "cloudtasks.projects.locations.queues.get"
+ "id": "cloudtasks.projects.locations.queues.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"
+ }
},
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
+ "get": {
+ "description": "Gets a queue.",
+ "httpMethod": "GET",
"response": {
"$ref": "Queue"
},
+ "parameterOrder": [
+ "name"
+ ],
"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": {
+ "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.",
+ "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/[^/]+$"
+ "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}",
- "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."
+ "id": "cloudtasks.projects.locations.queues.get",
+ "path": "v2beta2/{+name}"
},
"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.",
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:purge",
+ "id": "cloudtasks.projects.locations.queues.purge",
+ "path": "v2beta2/{+name}:purge",
"request": {
"$ref": "PurgeQueueRequest"
},
- "response": {
- "$ref": "Queue"
- },
+ "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"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "response": {
+ "$ref": "Queue"
+ },
"parameters": {
"name": {
"description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
@@ -164,9 +161,9 @@
"location": "path"
}
},
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:purge",
- "path": "v2beta2/{+name}:purge",
- "id": "cloudtasks.projects.locations.queues.purge"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
},
"testIamPermissions": {
"request": {
@@ -197,34 +194,36 @@
"id": "cloudtasks.projects.locations.queues.testIamPermissions"
},
"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"
},
- "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.",
- "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"
- }
- },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:pause",
- "id": "cloudtasks.projects.locations.queues.pause",
- "path": "v2beta2/{+name}:pause"
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:pause"
},
"delete": {
+ "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.",
"response": {
"$ref": "Empty"
@@ -233,9 +232,6 @@
"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`",
@@ -245,11 +241,15 @@
"location": "path"
}
},
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}",
- "path": "v2beta2/{+name}",
- "id": "cloudtasks.projects.locations.queues.delete"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}"
},
"list": {
+ "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.",
"response": {
"$ref": "ListQueuesResponse"
@@ -260,22 +260,22 @@
"httpMethod": "GET",
"parameters": {
"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",
+ "type": "string",
"location": "query"
},
+ "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"
+ },
"parent": {
- "location": "path",
"description": "Required.\n\nThe location name.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
},
"filter": {
"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.",
@@ -285,47 +285,20 @@
},
"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": {
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Queue"
- },
- "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"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues",
- "id": "cloudtasks.projects.locations.queues.create",
- "path": "v2beta2/{+parent}/queues"
+ ]
},
"setIamPolicy": {
- "response": {
- "$ref": "Policy"
+ "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`",
+ "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.",
@@ -339,40 +312,64 @@
"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`"
+ "path": "v2beta2/{+resource}:setIamPolicy"
},
- "resume": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
+ "create": {
"response": {
"$ref": "Queue"
},
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
"parameters": {
- "name": {
- "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`",
+ "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/[^/]+/queues/[^/]+$",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:resume",
- "id": "cloudtasks.projects.locations.queues.resume",
- "path": "v2beta2/{+name}:resume",
+ "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."
+ },
+ "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"
},
- "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)."
+ "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}:resume",
+ "path": "v2beta2/{+name}:resume",
+ "id": "cloudtasks.projects.locations.queues.resume"
},
"getIamPolicy": {
"request": {
@@ -388,11 +385,11 @@
"httpMethod": "POST",
"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"
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -406,14 +403,111 @@
"resources": {
"tasks": {
"methods": {
- "create": {
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
- "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"
+ "delete": {
+ "response": {
+ "$ref": "Empty"
},
+ "parameterOrder": [
+ "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`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$",
+ "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."
+ },
+ "pull": {
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:pull",
+ "path": "v2beta2/{+name}/tasks:pull",
+ "id": "cloudtasks.projects.locations.queues.tasks.pull",
+ "request": {
+ "$ref": "PullTasksRequest"
+ },
+ "description": "\nPulls tasks from a pull queue and acquires a lease on them for a\nspecified PullTasksRequest.lease_duration.\n\nThis method is invoked by the pull worker to obtain the\nlease. The pull worker must acknowledge the task via\nCloudTasks.AcknowledgeTask after they have performed the work\nassociated with the task.\n\nThe payload is intended to store data that the pull worker needs\nto perform the work associated with the task. To return the\npayloads in the PullTasksResponse, set\nPullTasksRequest.response_view to Task.View.FULL.\n\nA maximum of 10 qps of CloudTasks.PullTasks requests are allowed per\nqueue. google.rpc.Code.RESOURCE_EXHAUSTED is returned when this limit\nis exceeded. google.rpc.Code.RESOURCE_EXHAUSTED is also returned when\nRateLimits.max_tasks_dispatched_per_second is exceeded.",
+ "response": {
+ "$ref": "PullTasksResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "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"
+ ]
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListTasksResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "responseView": {
+ "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"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Sort order used for the query. The only fields supported for sorting\nare `schedule_time` and `pull_message.tag`. All results will be\nreturned in approximately ascending order. The default ordering is by\n`schedule_time`.",
+ "type": "string"
+ },
+ "pageToken": {
+ "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": {
+ "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}/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": {
"response": {
"$ref": "Task"
},
@@ -421,27 +515,27 @@
"parent"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"parent": {
+ "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",
- "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks",
+ "path": "v2beta2/{+parent}/tasks",
+ "id": "cloudtasks.projects.locations.queues.tasks.create",
+ "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."
},
"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.",
- "request": {
- "$ref": "RunTaskRequest"
- },
"response": {
"$ref": "Task"
},
@@ -449,20 +543,28 @@
"name"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"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}:run",
+ "path": "v2beta2/{+name}:run",
+ "id": "cloudtasks.projects.locations.queues.tasks.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": {
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:cancelLease",
"path": "v2beta2/{+name}:cancelLease",
"id": "cloudtasks.projects.locations.queues.tasks.cancelLease",
"description": "Cancel a pull task's lease.\n\nThe pull 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.PullTasks.",
@@ -481,75 +583,71 @@
],
"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"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:cancelLease"
- },
- "acknowledge": {
- "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 pull worker, that is, the entity that received this task in\na PullTasksResponse, must call this method to indicate that\nthe work associated with the task has finished.\n\nThe pull worker must acknowledge a task within the\nPullTasksRequest.lease_duration or the lease will expire and\nthe task will become ready to be returned in a different\nPullTasksResponse. After the task is acknowledged, it will\nnot be returned by a later CloudTasks.PullTasks,\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"
- },
- "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"
- }
- }
- },
- "renewLease": {
- "description": "Renew the current lease of a pull task.\n\nThe pull worker can use this method to extend the lease by a new\nduration, starting from now. The new task lease will be\nreturned in Task.schedule_time.",
- "request": {
- "$ref": "RenewLeaseRequest"
- },
- "response": {
- "$ref": "Task"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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/[^/]+$"
}
+ }
+ },
+ "acknowledge": {
+ "request": {
+ "$ref": "AcknowledgeTaskRequest"
},
+ "description": "Acknowledges a pull task.\n\nThe pull worker, that is, the entity that received this task in\na PullTasksResponse, must call this method to indicate that\nthe work associated with the task has finished.\n\nThe pull worker must acknowledge a task within the\nPullTasksRequest.lease_duration or the lease will expire and\nthe task will become ready to be returned in a different\nPullTasksResponse. After the task is acknowledged, it will\nnot be returned by a later CloudTasks.PullTasks,\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": {
+ "request": {
+ "$ref": "RenewLeaseRequest"
+ },
+ "description": "Renew the current lease of a pull task.\n\nThe pull worker can use this method to extend the lease by a new\nduration, starting from now. The new task lease will be\nreturned in Task.schedule_time.",
+ "response": {
+ "$ref": "Task"
+ },
+ "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}:renewLease",
"path": "v2beta2/{+name}:renewLease",
"id": "cloudtasks.projects.locations.queues.tasks.renewLease"
},
"get": {
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}",
- "path": "v2beta2/{+name}",
- "id": "cloudtasks.projects.locations.queues.tasks.get",
"description": "Gets a task.",
"response": {
"$ref": "Task"
@@ -579,11 +677,12 @@
"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"
}
- }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}",
+ "path": "v2beta2/{+name}",
+ "id": "cloudtasks.projects.locations.queues.tasks.get"
},
"lease": {
- "path": "v2beta2/{+parent}/tasks:lease",
- "id": "cloudtasks.projects.locations.queues.tasks.lease",
"description": "\nLeases tasks from a pull queue for LeaseTasksRequest.lease_duration.\n\nThis method is invoked by the pull worker to obtain a\nlease. The pull worker must acknowledge the task via\nCloudTasks.AcknowledgeTask after they have performed the work\nassociated with the task.\n\nThe payload is intended to store data that the pull worker needs\nto perform the work associated with the task. To return the\npayloads in the LeaseTasksResponse, set\nLeaseTasksRequest.response_view to Task.View.FULL.\n\nA maximum of 10 qps of CloudTasks.LeaseTasks requests are allowed per\nqueue. google.rpc.Code.RESOURCE_EXHAUSTED is returned when this limit\nis exceeded. google.rpc.Code.RESOURCE_EXHAUSTED is also returned when\nRateLimits.max_tasks_dispatched_per_second is exceeded.",
"request": {
"$ref": "LeaseTasksRequest"
@@ -600,118 +699,16 @@
],
"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/[^/]+$"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/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"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "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/[^/]+$",
+ "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$",
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}"
- },
- "pull": {
- "path": "v2beta2/{+name}/tasks:pull",
- "id": "cloudtasks.projects.locations.queues.tasks.pull",
- "request": {
- "$ref": "PullTasksRequest"
- },
- "description": "\nPulls tasks from a pull queue and acquires a lease on them for a\nspecified PullTasksRequest.lease_duration.\n\nThis method is invoked by the pull worker to obtain the\nlease. The pull worker must acknowledge the task via\nCloudTasks.AcknowledgeTask after they have performed the work\nassociated with the task.\n\nThe payload is intended to store data that the pull worker needs\nto perform the work associated with the task. To return the\npayloads in the PullTasksResponse, set\nPullTasksRequest.response_view to Task.View.FULL.\n\nA maximum of 10 qps of CloudTasks.PullTasks requests are allowed per\nqueue. google.rpc.Code.RESOURCE_EXHAUSTED is returned when this limit\nis exceeded. google.rpc.Code.RESOURCE_EXHAUSTED is also returned when\nRateLimits.max_tasks_dispatched_per_second is exceeded.",
- "response": {
- "$ref": "PullTasksResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "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:pull"
- },
- "list": {
- "path": "v2beta2/{+parent}/tasks",
- "id": "cloudtasks.projects.locations.queues.tasks.list",
- "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.",
- "response": {
- "$ref": "ListTasksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "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": {
- "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/[^/]+$"
- },
- "responseView": {
- "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"
- },
- "orderBy": {
- "location": "query",
- "description": "Sort order used for the query. The only fields supported for sorting\nare `schedule_time` and `pull_message.tag`. All results will be\nreturned in approximately ascending order. The default ordering is by\n`schedule_time`.",
- "type": "string"
- },
- "pageToken": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks"
+ "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:lease",
+ "path": "v2beta2/{+parent}/tasks:lease",
+ "id": "cloudtasks.projects.locations.queues.tasks.lease"
}
}
}
@@ -723,55 +720,39 @@
}
},
"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"
+ "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": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"$.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",
@@ -779,6 +760,11 @@
"type": "string"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -787,12 +773,7 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
+ "default": "json"
},
"access_token": {
"location": "query",
@@ -808,6 +789,22 @@
"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": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
}
},
"version": "v2beta2",
@@ -822,135 +819,9 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "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": {
- "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.",
- "$ref": "AppEngineRouting"
- }
- },
- "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": {
- "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": {
- "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 pull worker has successfully finished the work\nassociated with the task, the pull 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 pull 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": {
- "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",
- "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."
- ]
- }
- },
- "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 PullTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to ensure that your task\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.",
@@ -964,13 +835,9 @@
"type": "string"
}
},
- "id": "ListQueuesResponse",
- "description": "Response message for CloudTasks.ListQueues.",
- "type": "object"
+ "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).",
@@ -980,35 +847,30 @@
}
}
},
- "id": "TestIamPermissionsRequest"
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object"
},
"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"
},
"Policy": {
"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",
@@ -1018,6 +880,13 @@
"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",
@@ -1025,6 +894,8 @@
"type": "object"
},
"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 PullTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to ensure that your task\nworker currently holds the lease.",
@@ -1032,27 +903,23 @@
"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",
- "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."
- ]
+ "type": "string"
}
},
- "id": "CancelLeaseRequest",
- "description": "Request message for canceling a lease using\nCloudTasks.CancelLease.",
- "type": "object"
+ "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.",
@@ -1074,12 +941,17 @@
"type": "string"
}
},
- "id": "AttemptStatus"
+ "id": "AttemptStatus",
+ "description": "The status of a task attempt.",
+ "type": "object"
},
"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": {
+ "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"
+ },
"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.PullTasks 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",
@@ -1089,20 +961,11 @@
"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"
+ "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": {
"description": "Request message for CloudTasks.PauseQueue.",
@@ -1110,44 +973,13 @@
"properties": {},
"id": "PauseQueueRequest"
},
- "RunTaskRequest": {
- "description": "Request message for forcing a task to run now using\nCloudTasks.RunTask.",
+ "PurgeQueueRequest": {
+ "description": "Request message for CloudTasks.PurgeQueue.",
"type": "object",
- "properties": {
- "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": "RunTaskRequest"
- },
- "PullTasksResponse": {
- "description": "Response message for pulling tasks using CloudTasks.PullTasks.",
- "type": "object",
- "properties": {
- "tasks": {
- "description": "The leased tasks.",
- "type": "array",
- "items": {
- "$ref": "Task"
- }
- }
- },
- "id": "PullTasksResponse"
+ "properties": {},
+ "id": "PurgeQueueRequest"
},
"Task": {
- "description": "A unit of scheduled work.",
- "type": "object",
"properties": {
"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.",
@@ -1190,15 +1022,49 @@
"$ref": "TaskStatus"
}
},
- "id": "Task"
+ "id": "Task",
+ "description": "A unit of scheduled work.",
+ "type": "object"
+ },
+ "PullTasksResponse": {
+ "description": "Response message for pulling tasks using CloudTasks.PullTasks.",
+ "type": "object",
+ "properties": {
+ "tasks": {
+ "description": "The leased tasks.",
+ "type": "array",
+ "items": {
+ "$ref": "Task"
+ }
+ }
+ },
+ "id": "PullTasksResponse"
+ },
+ "RunTaskRequest": {
+ "description": "Request message for forcing a task to run now using\nCloudTasks.RunTask.",
+ "type": "object",
+ "properties": {
+ "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": "RunTaskRequest"
},
"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"
@@ -1207,17 +1073,20 @@
"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",
- "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"
},
"PullMessage": {
"description": "The pull message contains data that can be used by the caller of\nCloudTasks.PullTasks to process the task.\n\nThis proto can only be used for tasks in a queue which has\nQueue.pull_target set.",
@@ -1237,6 +1106,8 @@
"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",
@@ -1250,28 +1121,12 @@
"type": "string"
}
},
- "id": "Binding",
- "description": "Associates `members` with a `role`.",
- "type": "object"
+ "id": "Binding"
},
"RenewLeaseRequest": {
"description": "Request message for renewing a lease using CloudTasks.RenewLease.",
"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"
- },
"scheduleTime": {
"description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in PullTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to ensure that your task\nworker currently holds the lease.",
"format": "google-datetime",
@@ -1281,13 +1136,25 @@
"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": {
+ "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",
+ "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."
+ ]
}
},
"id": "RenewLeaseRequest"
},
"TaskStatus": {
- "description": "Status of the task.",
- "type": "object",
"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.",
@@ -1295,8 +1162,8 @@
"type": "string"
},
"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)."
+ "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).",
+ "$ref": "AttemptStatus"
},
"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).",
@@ -1304,20 +1171,18 @@
"type": "string"
},
"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)."
+ "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"
+ "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 will be sent to a task handler by an HTTP\nrequest using the specified AppEngineHttpRequest.http_method (for example\nPOST, HTTP GET, etc). The task attempt has succeeded if the task handler\nreturns an HTTP response code in the range [200 - 299]. Error 503 is\nconsidered an App Engine system error instead of an application error.\nRequests returning error 503 will be retried regardless of retry\nconfiguration 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": {
- "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"
@@ -1330,6 +1195,8 @@
"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": {
+ "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 RequestHandler](/appengine/docs/python/tools/webapp/requesthandlerclass).",
+ "type": "string",
"enumDescriptions": [
"HTTP method unspecified",
"HTTP Post",
@@ -1345,18 +1212,26 @@
"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 RequestHandler](/appengine/docs/python/tools/webapp/requesthandlerclass).",
- "type": "string"
+ ]
},
"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"
},
+ "GetIamPolicyRequest": {
+ "properties": {},
+ "id": "GetIamPolicyRequest",
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object"
+ },
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
@@ -1371,19 +1246,8 @@
},
"id": "TestIamPermissionsResponse"
},
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
- },
"RetryConfig": {
"properties": {
- "maxRetryDuration": {
- "description": "If positive, `max_retry_duration` specifies the time limit for retrying a\nfailed task, measured from when the task was first attempted. Once\n`max_retry_duration` time has passed *and* the task has been attempted\nRetryConfig.max_attempts times, no further attempts will be made and\nthe task will be deleted.\n\nIf zero, then the task age is unlimited.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n this field is 0 seconds by default.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this\n field is output only and always 0.\n\n`max_retry_duration` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[task_age_limit in queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
- "format": "google-duration",
- "type": "string"
- },
"maxDoublings": {
"description": "The time between retries will double `max_doublings` times.\n\nA task's retry interval starts at RetryConfig.min_backoff,\nthen doubles `max_doublings` times, then increases linearly, and\nfinally retries retries at intervals of\nRetryConfig.max_backoff up to max_attempts times.\n\nFor example, if RetryConfig.min_backoff is 10s,\nRetryConfig.max_backoff is 300s, and `max_doublings` is 3,\nthen the a task will first be retried in 10s. The retry interval\nwill double three times, and then increase linearly by 2^3 * 10s.\nFinally, the task will retry at intervals of\nRetryConfig.max_backoff until the task has been attempted\n`max_attempts` times. Thus, the requests will retry at 10s, 20s,\n40s, 80s, 160s, 240s, 300s, 300s, ....\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n this field is 16 by default.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this field\n is output only and always 0.\n\nThis field has the same meaning as\n[max_doublings in queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
"format": "int32",
@@ -1407,6 +1271,11 @@
"description": "The maximum amount of time to wait before retrying a task after\nit fails. The default is 1 hour.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n this field is 1 hour by default.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this field\n is output only and always 0.\n\n`max_backoff` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[max_backoff_seconds in queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
"format": "google-duration",
"type": "string"
+ },
+ "maxRetryDuration": {
+ "description": "If positive, `max_retry_duration` specifies the time limit for retrying a\nfailed task, measured from when the task was first attempted. Once\n`max_retry_duration` time has passed *and* the task has been attempted\nRetryConfig.max_attempts times, no further attempts will be made and\nthe task will be deleted.\n\nIf zero, then the task age is unlimited.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n this field is 0 seconds by default.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this\n field is output only and always 0.\n\n`max_retry_duration` will be truncated to the nearest second.\n\nThis field has the same meaning as\n[task_age_limit in queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).",
+ "format": "google-duration",
+ "type": "string"
}
},
"id": "RetryConfig",
@@ -1414,18 +1283,20 @@
"type": "object"
},
"PullTarget": {
- "properties": {},
- "id": "PullTarget",
"description": "Pull target.",
- "type": "object"
- },
- "ResumeQueueRequest": {
- "description": "Request message for CloudTasks.ResumeQueue.",
"type": "object",
"properties": {},
- "id": "ResumeQueueRequest"
+ "id": "PullTarget"
+ },
+ "ResumeQueueRequest": {
+ "properties": {},
+ "id": "ResumeQueueRequest",
+ "description": "Request message for CloudTasks.ResumeQueue.",
+ "type": "object"
},
"ListTasksResponse": {
+ "description": "Response message for listing tasks using CloudTasks.ListTasks.",
+ "type": "object",
"properties": {
"tasks": {
"description": "The list of tasks.",
@@ -1439,19 +1310,19 @@
"type": "string"
}
},
- "id": "ListTasksResponse",
- "description": "Response message for listing tasks using CloudTasks.ListTasks.",
- "type": "object"
+ "id": "ListTasksResponse"
},
"CreateTaskRequest": {
"description": "Request message for CloudTasks.CreateTask.",
"type": "object",
"properties": {
"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.",
- "$ref": "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": {
+ "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.",
@@ -1461,9 +1332,7 @@
"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": "CreateTaskRequest"
@@ -1486,15 +1355,19 @@
"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": {
+ "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"
},
- "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).",
- "$ref": "RetryConfig"
- },
"state": {
"enumDescriptions": [
"Unspecified state.",
@@ -1511,6 +1384,10 @@
"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": {
+ "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).",
+ "$ref": "RetryConfig"
+ },
"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"
@@ -1518,14 +1395,6 @@
"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": {
- "description": "Pull target.\n\nA pull queue is a queue that has a PullTarget.",
- "$ref": "PullTarget"
- },
- "appEngineHttpTarget": {
- "description": "App Engine HTTP target.\n\nAn App Engine queue is a queue that has an AppEngineHttpTarget.",
- "$ref": "AppEngineHttpTarget"
}
},
"id": "Queue"
@@ -1564,13 +1433,141 @@
}
},
"id": "PullTasksRequest"
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "AppEngineRouting"
+ },
+ "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"
+ },
+ "AppEngineHttpTarget": {
+ "properties": {
+ "appEngineRoutingOverride": {
+ "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.",
+ "$ref": "AppEngineRouting"
+ }
+ },
+ "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": {
+ "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": {
+ "description": "Request message for pulling tasks using CloudTasks.LeaseTasks.",
+ "type": "object",
+ "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 pull worker has successfully finished the work\nassociated with the task, the pull 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 pull 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"
+ },
+ "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 PullTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to ensure that your task\nworker currently holds the lease.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "AcknowledgeTaskRequest"
}
},
- "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": "Cloud Tasks",
"auth": {
"oauth2": {
@@ -1580,5 +1577,8 @@
}
}
}
- }
+ },
+ "rootUrl": "https://cloudtasks.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudtasks"
}
diff --git a/cloudtrace/v1/cloudtrace-api.json b/cloudtrace/v1/cloudtrace-api.json
index b0cb649..6f8e81f 100644
--- a/cloudtrace/v1/cloudtrace-api.json
+++ b/cloudtrace/v1/cloudtrace-api.json
@@ -1,4 +1,244 @@
{
+ "title": "Stackdriver Trace API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "methods": {
+ "patchTraces": {
+ "flatPath": "v1/projects/{projectId}/traces",
+ "path": "v1/projects/{projectId}/traces",
+ "id": "cloudtrace.projects.patchTraces",
+ "description": "Sends new traces to Stackdriver Trace or updates existing traces. If the ID\nof a trace that you send matches that of an existing trace, any fields\nin the existing trace and its spans are overwritten by the provided values,\nand any new fields provided are merged with the existing trace data. If the\nID does not match, a new trace is created.",
+ "request": {
+ "$ref": "Traces"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.append"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "ID of the Cloud project where the trace data is stored.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ }
+ },
+ "resources": {
+ "traces": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListTracesResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.readonly"
+ ],
+ "parameters": {
+ "endTime": {
+ "location": "query",
+ "description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "pageToken": {
+ "type": "string",
+ "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."
+ },
+ "startTime": {
+ "location": "query",
+ "description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "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"
+ },
+ "view": {
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "Field used to sort the returned traces. Optional.\nCan be one of the following:\n\n* `trace_id`\n* `name` (`name` field of root span in the trace)\n* `duration` (difference between `end_time` and `start_time` fields of\n the root span)\n* `start` (`start_time` field of the root span)\n\nDescending order can be specified by appending `desc` to the sort field\n(for example, `name desc`).\n\nOnly one sort field is permitted."
+ },
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the Cloud project where the trace data is stored."
+ },
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "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`."
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/traces",
+ "path": "v1/projects/{projectId}/traces",
+ "id": "cloudtrace.projects.traces.list",
+ "description": "Returns of a list of traces that match the specified filter conditions."
+ },
+ "get": {
+ "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.",
+ "response": {
+ "$ref": "Trace"
+ },
+ "parameterOrder": [
+ "projectId",
+ "traceId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.readonly"
+ ],
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the Cloud project where the trace data is stored."
+ },
+ "traceId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the trace to return."
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "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"
+ },
+ "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": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
+ },
+ "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": {
+ "type": "string",
+ "location": "query",
+ "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."
+ }
+ },
+ "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": {
@@ -6,10 +246,41 @@
"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": {
- "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.",
+ "endTime": {
+ "description": "End time of the span in nanoseconds from the UNIX epoch.",
+ "format": "google-datetime",
"type": "string"
},
+ "startTime": {
+ "type": "string",
+ "description": "Start time of the span in nanoseconds from the UNIX epoch.",
+ "format": "google-datetime"
+ },
+ "kind": {
+ "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",
+ "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."
+ ]
+ },
+ "labels": {
+ "type": "object",
+ "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`"
+ },
+ "name": {
+ "type": "string",
+ "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."
+ },
"spanId": {
"description": "Identifier for the span. Must be a 64-bit integer other than 0 and\nunique within a trace.",
"format": "uint64",
@@ -19,67 +290,35 @@
"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": {
- "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",
- "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"
- ]
- },
- "labels": {
- "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",
- "additionalProperties": {
- "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"
- }
+ },
+ "description": "List of trace records returned."
},
"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"
+ "id": "ListTracesResponse",
+ "description": "The response message for the `ListTraces` method."
},
"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 `{}`."
},
"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": {
@@ -87,20 +326,22 @@
"type": "string"
},
"spans": {
- "description": "Collection of spans in the trace.",
"type": "array",
"items": {
"$ref": "TraceSpan"
- }
+ },
+ "description": "Collection of spans in the trace."
},
"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"
+ "type": "string",
+ "description": "Globally unique identifier for the trace. This identifier is a 128-bit\nnumeric value formatted as a 32-byte hex string."
}
},
- "id": "Trace"
+ "id": "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."
},
"Traces": {
+ "type": "object",
"properties": {
"traces": {
"description": "List of traces.",
@@ -111,8 +352,7 @@
}
},
"id": "Traces",
- "description": "List of new or updated traces.",
- "type": "object"
+ "description": "List of new or updated traces."
}
},
"protocol": "rest",
@@ -140,245 +380,5 @@
"ownerDomain": "google.com",
"name": "cloudtrace",
"batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Stackdriver Trace API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "methods": {
- "patchTraces": {
- "flatPath": "v1/projects/{projectId}/traces",
- "path": "v1/projects/{projectId}/traces",
- "id": "cloudtrace.projects.patchTraces",
- "request": {
- "$ref": "Traces"
- },
- "description": "Sends new traces to Stackdriver Trace or updates existing traces. If the ID\nof a trace that you send matches that of an existing trace, any fields\nin the existing trace and its spans are overwritten by the provided values,\nand any new fields provided are merged with the existing trace data. If the\nID does not match, a new trace is created.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "projectId": {
- "description": "ID of the Cloud project where the trace data is stored.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.append"
- ]
- }
- },
- "resources": {
- "traces": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListTracesResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.readonly"
- ],
- "parameters": {
- "orderBy": {
- "description": "Field used to sort the returned traces. Optional.\nCan be one of the following:\n\n* `trace_id`\n* `name` (`name` field of root span in the trace)\n* `duration` (difference between `end_time` and `start_time` fields of\n the root span)\n* `start` (`start_time` field of the root span)\n\nDescending order can be specified by appending `desc` to the sort field\n(for example, `name desc`).\n\nOnly one sort field is permitted.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "description": "ID of the Cloud project where the trace data is stored.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "filter": {
- "location": "query",
- "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"
- },
- "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"
- },
- "startTime": {
- "description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "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.",
- "type": "string"
- },
- "pageSize": {
- "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",
- "location": "query"
- },
- "view": {
- "enum": [
- "VIEW_TYPE_UNSPECIFIED",
- "MINIMAL",
- "ROOTSPAN",
- "COMPLETE"
- ],
- "description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/projects/{projectId}/traces",
- "path": "v1/projects/{projectId}/traces",
- "id": "cloudtrace.projects.traces.list",
- "description": "Returns of a list of traces that match the specified filter conditions."
- },
- "get": {
- "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.",
- "response": {
- "$ref": "Trace"
- },
- "parameterOrder": [
- "projectId",
- "traceId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- ]
- }
- }
- }
- }
- }
- },
- "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"
- },
- "$.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": {
- "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://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:v1"
+ "fullyEncodeReservedExpansion": true
}
diff --git a/cloudtrace/v2/cloudtrace-api.json b/cloudtrace/v2/cloudtrace-api.json
index e96d3b0..c467065 100644
--- a/cloudtrace/v2/cloudtrace-api.json
+++ b/cloudtrace/v2/cloudtrace-api.json
@@ -1,96 +1,36 @@
{
+ "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": "",
+ "id": "cloudtrace:v2",
+ "documentationLink": "https://cloud.google.com/trace",
+ "revision": "20171214",
+ "discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "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": {
- "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"
- },
- "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",
- "type": "integer"
- },
- "timeEvent": {
- "description": "A collection of `TimeEvent`s.",
- "type": "array",
- "items": {
- "$ref": "TimeEvent"
- }
- }
- },
- "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"
- },
- "buildId": {
- "description": "A unique identifier for the module, usually a hash of its\ncontents (up to 128 bytes).",
- "$ref": "TruncatableString"
- }
- },
- "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": {
- "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"
- },
- "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.",
- "type": "array",
- "items": {
- "$ref": "Span"
- }
- }
- },
- "id": "BatchWriteSpansRequest"
- },
- "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"
- },
"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": {
+ "timeEvents": {
+ "description": "A set of time events. You can have up to 32 annotations and 128 message\nevents per span.",
+ "$ref": "TimeEvents"
+ },
+ "links": {
+ "$ref": "Links",
+ "description": "Links associated with the span. You can have up to 128 links per Span."
+ },
+ "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"
+ },
"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",
@@ -109,8 +49,8 @@
"type": "string"
},
"stackTrace": {
- "description": "Stack trace captured at the start of the span.",
- "$ref": "StackTrace"
+ "$ref": "StackTrace",
+ "description": "Stack trace captured at the start of the span."
},
"parentSpanId": {
"description": "The [SPAN_ID] of this span's parent span. If this is a root span,\nthen this field must be empty.",
@@ -129,42 +69,32 @@
"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"
- },
- "timeEvents": {
- "$ref": "TimeEvents",
- "description": "A set of time events. You can have up to 32 annotations and 128 message\nevents per span."
- },
- "links": {
- "$ref": "Links",
- "description": "Links associated with the span. You can have up to 128 links per Span."
- },
- "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"
}
},
"id": "Span"
},
+ "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"
+ },
"AttributeValue": {
"description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.",
"type": "object",
"properties": {
- "stringValue": {
- "description": "A string up to 256 bytes long.",
- "$ref": "TruncatableString"
- },
- "boolValue": {
- "description": "A Boolean value represented by `true` or `false`.",
- "type": "boolean"
- },
"intValue": {
"description": "A 64-bit signed integer.",
"format": "int64",
"type": "string"
+ },
+ "stringValue": {
+ "$ref": "TruncatableString",
+ "description": "A string up to 256 bytes long."
+ },
+ "boolValue": {
+ "description": "A Boolean value represented by `true` or `false`.",
+ "type": "boolean"
}
},
"id": "AttributeValue"
@@ -207,22 +137,6 @@
},
"id": "Links"
},
- "StackTrace": {
- "description": "A call stack appearing in a trace.",
- "type": "object",
- "properties": {
- "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`.",
- "format": "int64",
- "type": "string"
- },
- "stackFrames": {
- "description": "Stack frames in this stack trace. A maximum of 128 frames are allowed.",
- "$ref": "StackFrames"
- }
- },
- "id": "StackTrace"
- },
"TruncatableString": {
"description": "Represents a string that might be shortened to a specified length.",
"type": "object",
@@ -239,11 +153,29 @@
},
"id": "TruncatableString"
},
+ "StackTrace": {
+ "description": "A call stack appearing in a trace.",
+ "type": "object",
+ "properties": {
+ "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`.",
+ "format": "int64",
+ "type": "string"
+ },
+ "stackFrames": {
+ "description": "Stack frames in this stack trace. A maximum of 128 frames are allowed.",
+ "$ref": "StackFrames"
+ }
+ },
+ "id": "StackTrace"
+ },
"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"
+ "$ref": "Annotation",
+ "description": "Text annotation with a set of attributes."
},
"messageEvent": {
"$ref": "MessageEvent",
@@ -255,28 +187,10 @@
"type": "string"
}
},
- "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": {
- "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"
- },
"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.",
"format": "int64",
@@ -291,14 +205,32 @@
"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"
}
},
- "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": {
+ "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": {
"$ref": "TruncatableString",
"description": "The fully-qualified name that uniquely identifies the function or\nmethod that is active in this frame (up to 1024 bytes)."
@@ -318,37 +250,35 @@
"type": "string"
},
"fileName": {
- "$ref": "TruncatableString",
- "description": "The name of the source file where the function call appears (up to 256\nbytes)."
+ "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": {
- "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).",
+ "description": "The version of the deployed source code (up to 128 bytes).",
"$ref": "TruncatableString"
}
},
- "id": "StackFrame"
+ "id": "StackFrame",
+ "description": "Represents a single stack frame in a stack trace.",
+ "type": "object"
},
"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": {
"type": {
+ "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"
],
"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."
- ]
+ "type": "string"
},
"traceId": {
"description": "The [TRACE_ID] for a trace within a project.",
@@ -369,18 +299,20 @@
"description": "Text annotation with a set of attributes.",
"type": "object",
"properties": {
+ "description": {
+ "$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."
- },
- "description": {
- "description": "A user-supplied message describing the event. The maximum length for\nthe description is 256 bytes.",
- "$ref": "TruncatableString"
}
},
"id": "Annotation"
},
"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.",
@@ -395,25 +327,103 @@
}
}
},
- "id": "StackFrames",
- "description": "A collection of stack frames, which can be truncated.",
+ "id": "StackFrames"
+ },
+ "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",
+ "type": "integer"
+ },
+ "timeEvent": {
+ "description": "A collection of `TimeEvent`s.",
+ "type": "array",
+ "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"
+ },
+ "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"
+ },
+ "buildId": {
+ "$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": {
+ "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"
+ },
+ "BatchWriteSpansRequest": {
+ "properties": {
+ "spans": {
+ "description": "A list of new spans. The span names must not match existing\nspans, or the results are undefined.",
+ "type": "array",
+ "items": {
+ "$ref": "Span"
+ }
+ }
+ },
+ "id": "BatchWriteSpansRequest",
+ "description": "The request message for the `BatchWriteSpans` method.",
"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 Trace",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/trace.append": {
- "description": "Write Trace data for a project or application"
- },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/trace.append": {
+ "description": "Write Trace data for a project or application"
}
}
}
@@ -440,11 +450,11 @@
"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"
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -464,33 +474,33 @@
"spans": {
"methods": {
"createSpan": {
- "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"
- }
- },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.append"
],
- "flatPath": "v2/projects/{projectsId}/traces/{tracesId}/spans/{spansId}"
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/traces/[^/]+/spans/[^/]+$",
+ "location": "path",
+ "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"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/traces/{tracesId}/spans/{spansId}",
+ "path": "v2/{+name}",
+ "id": "cloudtrace.projects.traces.spans.createSpan",
+ "description": "Creates a new span.",
+ "request": {
+ "$ref": "Span"
+ }
}
}
}
@@ -500,31 +510,52 @@
}
},
"parameters": {
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
+ "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": {
"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",
"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": {
"description": "Selector specifying which fields to include in a partial response.",
@@ -550,12 +581,6 @@
"location": "query"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -563,38 +588,13 @@
],
"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.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"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": {
- "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",
- "discoveryVersion": "v1"
+ }
}
diff --git a/container/v1/container-api.json b/container/v1/container-api.json
index 847c4d5..a3a4260 100644
--- a/container/v1/container-api.json
+++ b/container/v1/container-api.json
@@ -1,34 +1,1580 @@
{
+ "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 Container Engine service.",
+ "response": {
+ "$ref": "ServerConfig"
+ },
+ "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).",
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/serverconfig",
+ "path": "v1/projects/{projectId}/zones/{zone}/serverconfig",
+ "id": "container.projects.zones.getServerconfig"
+ }
+ },
+ "resources": {
+ "clusters": {
+ "methods": {
+ "startIpRotation": {
+ "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": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
+ },
+ "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",
+ "request": {
+ "$ref": "StartIPRotationRequest"
+ },
+ "description": "Start master IP rotation."
+ },
+ "addons": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
+ },
+ "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": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the cluster to upgrade."
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
+ "id": "container.projects.zones.clusters.addons",
+ "description": "Sets the addons of a specific cluster.",
+ "request": {
+ "$ref": "SetAddonsConfigRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST"
+ },
+ "setMaintenancePolicy": {
+ "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": {
+ "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",
+ "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."
+ },
+ "delete": {
+ "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.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
+ },
+ "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}"
+ },
+ "locations": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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 upgrade.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
+ "id": "container.projects.zones.clusters.locations",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
+ "description": "Sets the locations of a specific cluster.",
+ "request": {
+ "$ref": "SetLocationsRequest"
+ }
+ },
+ "update": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to upgrade.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "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.update",
+ "request": {
+ "$ref": "UpdateClusterRequest"
+ },
+ "description": "Updates the settings of a specific cluster."
+ },
+ "monitoring": {
+ "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 upgrade.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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."
+ },
+ "master": {
+ "path": "v1/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": {
+ "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}/master"
+ },
+ "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": {
+ "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"
+ },
+ "projectId": {
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
+ "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": {
+ "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": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to upgrade.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
+ "path": "v1/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": {
+ "id": "container.projects.zones.clusters.list",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters",
+ "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": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters",
+ "id": "container.projects.zones.clusters.create"
+ },
+ "resourceLabels": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber)."
+ },
+ "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": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the cluster."
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
+ "id": "container.projects.zones.clusters.resourceLabels",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
+ "description": "Sets labels on a cluster.",
+ "request": {
+ "$ref": "SetLabelsRequest"
+ }
+ },
+ "completeIpRotation": {
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
+ "id": "container.projects.zones.clusters.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": {
+ "clusterId": {
+ "description": "The name of the cluster.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
+ }
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "GET",
+ "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 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",
+ "description": "Gets the details of a specific cluster."
+ },
+ "legacyAbac": {
+ "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 update.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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",
+ "request": {
+ "$ref": "SetLegacyAbacRequest"
+ },
+ "description": "Enables or disables the ABAC authorization mechanism on a cluster."
+ },
+ "setNetworkPolicy": {
+ "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": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
+ "id": "container.projects.zones.clusters.setNetworkPolicy",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
+ "request": {
+ "$ref": "SetNetworkPolicyRequest"
+ },
+ "description": "Enables/Disables Network Policy for a cluster."
+ }
+ },
+ "resources": {
+ "nodePools": {
+ "methods": {
+ "setSize": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to update.",
+ "required": true,
+ "type": "string"
+ },
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool to update.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "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",
+ "description": "Sets the size of a specific node pool.",
+ "request": {
+ "$ref": "SetNodePoolSizeRequest"
+ }
+ },
+ "setManagement": {
+ "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",
+ "request": {
+ "$ref": "SetNodePoolManagementRequest"
+ },
+ "description": "Sets the NodeManagement options for a node pool.",
+ "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": {
+ "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"
+ },
+ "nodePoolId": {
+ "description": "The name of the node pool to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "nodePoolId": {
+ "description": "The name of the node pool to delete.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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": {
+ "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.delete",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}",
+ "description": "Deletes a node pool from a cluster."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListNodePoolsResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "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://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": {
+ "description": "The name of the cluster.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "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",
+ "description": "Lists the node pools for a cluster."
+ },
+ "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).",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "zone": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to rollback.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ },
+ "create": {
+ "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}/nodePools",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools",
+ "id": "container.projects.zones.clusters.nodePools.create",
+ "description": "Creates a node pool for a cluster.",
+ "request": {
+ "$ref": "CreateNodePoolRequest"
+ }
+ },
+ "autoscaling": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
+ },
+ "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"
+ },
+ "nodePoolId": {
+ "description": "The name of the node pool to upgrade.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "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"
+ },
+ "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": {
+ "location": "path",
+ "description": "The name of the node pool.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "response": {
+ "$ref": "NodePool"
+ }
+ },
+ "update": {
+ "description": "Updates the version and/or image type of a specific node pool.",
+ "request": {
+ "$ref": "UpdateNodePoolRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool to upgrade.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
+ "id": "container.projects.zones.clusters.nodePools.update",
+ "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update"
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "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": {
+ "location": "path",
+ "description": "The server-assigned `name` of the operation.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ "id": "container.projects.zones.operations.cancel"
+ },
+ "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).",
+ "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"
+ ],
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/operations",
+ "path": "v1/projects/{projectId}/zones/{zone}/operations",
+ "id": "container.projects.zones.operations.list"
+ },
+ "get": {
+ "description": "Gets the specified operation.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "operationId": {
+ "location": "path",
+ "description": "The server-assigned `name` of the operation.",
+ "required": true,
+ "type": "string"
+ },
+ "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": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
+ "id": "container.projects.zones.operations.get",
+ "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "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": {
+ "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"
+ ]
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://container.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "The Google Container Engine API is used for building and managing container based applications, powered by the open source Kubernetes technology.",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20171111",
+ "documentationLink": "https://cloud.google.com/container-engine/",
+ "id": "container:v1",
"discoveryVersion": "v1",
"schemas": {
+ "ListOperationsResponse": {
+ "description": "ListOperationsResponse is the result of ListOperationsRequest.",
+ "type": "object",
+ "properties": {
+ "operations": {
+ "description": "A list of operations in the project in the specified zone.",
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ }
+ },
+ "missingZones": {
+ "description": "If any zones are listed here, the list of operations returned\nmay be missing the operations from those zones.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ListOperationsResponse"
+ },
+ "SetMonitoringServiceRequest": {
+ "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"
+ }
+ },
+ "id": "SetMonitoringServiceRequest"
+ },
+ "CidrBlock": {
+ "description": "CidrBlock contains an optional name and one CIDR block.",
+ "type": "object",
+ "properties": {
+ "cidrBlock": {
+ "type": "string",
+ "description": "cidr_block must be specified in CIDR notation."
+ },
+ "displayName": {
+ "description": "display_name is an optional field for users to identify CIDR blocks.",
+ "type": "string"
+ }
+ },
+ "id": "CidrBlock"
+ },
+ "ServerConfig": {
+ "properties": {
+ "validNodeVersions": {
+ "description": "List of valid node upgrade target versions.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "validImageTypes": {
+ "description": "List of valid image types.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "validMasterVersions": {
+ "description": "List of valid master versions.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "defaultClusterVersion": {
+ "description": "Version of Kubernetes the service deploys by default.",
+ "type": "string"
+ },
+ "defaultImageType": {
+ "description": "Default image type.",
+ "type": "string"
+ }
+ },
+ "id": "ServerConfig",
+ "description": "Container Engine service configuration.",
+ "type": "object"
+ },
+ "NodeConfig": {
+ "description": "Parameters that describe the nodes in a cluster.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the four reserved keys:\n\"instance-template\", \"kube-env\", \"startup-script\", and \"user-data\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
+ "type": "object"
+ },
+ "tags": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of instance tags applied to all nodes. Tags are used to identify\nvalid sources or targets for network firewalls and are specified by\nthe client during cluster or node pool creation. Each tag within the list\nmust comply with RFC1035."
+ },
+ "serviceAccount": {
+ "description": "The Google Cloud Platform Service Account to be used by the node VMs. If\nno Service Account is specified, the \"default\" service account is used.",
+ "type": "string"
+ },
+ "imageType": {
+ "description": "The image type to use for this node. Note that for a given image type,\nthe latest version of it will be used.",
+ "type": "string"
+ },
+ "oauthScopes": {
+ "description": "The set of Google API scopes to be made available on all of the\nnode VMs under the \"default\" service account.\n\nThe following scopes are recommended, but not required, and by default are\nnot included:\n\n* `https://www.googleapis.com/auth/compute` is required for mounting\npersistent storage on your nodes.\n* `https://www.googleapis.com/auth/devstorage.read_only` is required for\ncommunicating with **gcr.io**\n(the [Google Container Registry](/container-registry/)).\n\nIf unspecified, no scopes are added, unless Cloud Logging or Cloud\nMonitoring are enabled, in which case their required scopes will be added.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "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": {
+ "type": "boolean",
+ "description": "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninformation about preemptible VM instances."
+ },
+ "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"
+ },
+ "AutoUpgradeOptions": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade."
+ },
+ "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",
+ "description": "AutoUpgradeOptions defines the set of options for the user to control how\nthe Auto Upgrades will proceed."
+ },
+ "ListClustersResponse": {
+ "description": "ListClustersResponse is the result of ListClustersRequest.",
+ "type": "object",
+ "properties": {
+ "clusters": {
+ "description": "A list of clusters in the project in the specified zone, or\nacross all ones.",
+ "type": "array",
+ "items": {
+ "$ref": "Cluster"
+ }
+ },
+ "missingZones": {
+ "description": "If any zones are listed here, the list of clusters returned\nmay be missing those zones.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "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": {
- "type": "boolean",
- "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."
+ "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"
},
- "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": {
- "networkPolicy": {
- "$ref": "NetworkPolicy",
- "description": "Configuration options for the NetworkPolicy feature."
- }
- },
- "id": "SetNetworkPolicyRequest",
- "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster."
- },
- "NodePoolAutoscaling": {
- "properties": {
"maxNodeCount": {
- "type": "integer",
"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"
+ "format": "int32",
+ "type": "integer"
},
"minNodeCount": {
"description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.",
@@ -40,11 +1586,21 @@
"type": "boolean"
}
},
- "id": "NodePoolAutoscaling",
- "description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage.",
- "type": "object"
+ "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"
},
"SetMasterAuthRequest": {
+ "description": "SetMasterAuthRequest updates the admin password of a cluster.",
"type": "object",
"properties": {
"update": {
@@ -68,44 +1624,10 @@
"type": "string"
}
},
- "id": "SetMasterAuthRequest",
- "description": "SetMasterAuthRequest updates the admin password of a cluster."
+ "id": "SetMasterAuthRequest"
},
"IPAllocationPolicy": {
- "type": "object",
"properties": {
- "servicesIpv4CidrBlock": {
- "type": "string",
- "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."
- },
- "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": {
- "type": "string",
- "description": "This field is deprecated, use services_ipv4_cidr_block."
- },
"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"
@@ -117,16 +1639,63 @@
"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": {
+ "type": "string",
+ "description": "This field is deprecated, use cluster_ipv4_cidr_block."
+ },
+ "nodeIpv4Cidr": {
+ "type": "string",
+ "description": "This field is deprecated, use node_ipv4_cidr_block."
+ },
+ "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",
- "description": "Configuration for controlling how IPs are allocated in the cluster."
+ "description": "Configuration for controlling how IPs are allocated in the cluster.",
+ "type": "object"
},
"ClusterUpdate": {
- "id": "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": {
+ "desiredMasterAuthorizedNetworksConfig": {
+ "$ref": "MasterAuthorizedNetworksConfig",
+ "description": "Master authorized networks is a Beta feature.\nThe desired configuration options for master authorized networks feature."
+ },
+ "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."
+ },
+ "desiredLocations": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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."
+ },
"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"
@@ -136,8 +1705,8 @@
"type": "string"
},
"desiredAddonsConfig": {
- "description": "Configurations for the various addons available to run in the cluster.",
- "$ref": "AddonsConfig"
+ "$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.",
@@ -150,36 +1719,23 @@
"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"
- },
- "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."
- },
- "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"
- }
}
- }
+ },
+ "id": "ClusterUpdate"
},
"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"
+ "id": "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"
},
"MasterAuthorizedNetworksConfig": {
+ "type": "object",
"properties": {
"enabled": {
"description": "Whether or not master authorized networks is enabled.",
@@ -194,11 +1750,9 @@
}
},
"id": "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"
+ "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."
},
"SetNodePoolManagementRequest": {
- "id": "SetNodePoolManagementRequest",
"description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.",
"type": "object",
"properties": {
@@ -206,10 +1760,10 @@
"$ref": "NodeManagement",
"description": "NodeManagement configuration for the node pool."
}
- }
+ },
+ "id": "SetNodePoolManagementRequest"
},
"SetNodePoolAutoscalingRequest": {
- "id": "SetNodePoolAutoscalingRequest",
"description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.",
"type": "object",
"properties": {
@@ -217,18 +1771,19 @@
"description": "Autoscaling configuration for the node pool.",
"$ref": "NodePoolAutoscaling"
}
- }
+ },
+ "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",
- "description": "CreateClusterRequest creates a cluster.",
- "type": "object"
+ "id": "CreateClusterRequest"
},
"LegacyAbac": {
"description": "Configuration for the legacy Attribute Based Access Control authorization\nmode.",
@@ -246,9 +1801,9 @@
"type": "object",
"properties": {
"acceleratorCount": {
- "type": "string",
"description": "The number of the accelerator cards exposed to an instance.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"acceleratorType": {
"description": "The accelerator type resource name. List of supported accelerators\n[here](/compute/docs/gpus/#Introduction)",
@@ -261,29 +1816,30 @@
"description": "UpdateNodePoolRequests update a node pool's image and/or version.",
"type": "object",
"properties": {
+ "imageType": {
+ "type": "string",
+ "description": "The desired image type for the node pool."
+ },
"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"
- },
- "imageType": {
- "description": "The desired image type for the node pool.",
- "type": "string"
}
},
"id": "UpdateNodePoolRequest"
},
"SetAddonsConfigRequest": {
- "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",
- "description": "SetAddonsConfigRequest sets the addons associated with the cluster."
+ "description": "SetAddonsConfigRequest sets the addons associated with the cluster.",
+ "type": "object"
},
"SetLegacyAbacRequest": {
+ "id": "SetLegacyAbacRequest",
"description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for\na cluster.",
"type": "object",
"properties": {
@@ -291,28 +1847,27 @@
"description": "Whether ABAC authorization will be enabled in the cluster.",
"type": "boolean"
}
- },
- "id": "SetLegacyAbacRequest"
+ }
},
"AddonsConfig": {
"description": "Configuration for the addons that can be automatically spun up in the\ncluster, enabling additional functionality.",
"type": "object",
"properties": {
- "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."
- },
"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."
+ },
+ "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."
}
},
"id": "AddonsConfig"
@@ -322,17 +1877,16 @@
"type": "object",
"properties": {
"locations": {
- "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"
- }
+ },
+ "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."
}
},
"id": "SetLocationsRequest"
},
"SetNodePoolSizeRequest": {
- "description": "SetNodePoolSizeRequest sets the size a node\npool.",
"type": "object",
"properties": {
"nodeCount": {
@@ -341,7 +1895,8 @@
"type": "integer"
}
},
- "id": "SetNodePoolSizeRequest"
+ "id": "SetNodePoolSizeRequest",
+ "description": "SetNodePoolSizeRequest sets the size a node\npool."
},
"NetworkPolicyConfig": {
"id": "NetworkPolicyConfig",
@@ -355,25 +1910,29 @@
}
},
"UpdateClusterRequest": {
+ "id": "UpdateClusterRequest",
"description": "UpdateClusterRequest updates the settings of a cluster.",
"type": "object",
"properties": {
"update": {
- "description": "A description of the update.",
- "$ref": "ClusterUpdate"
+ "$ref": "ClusterUpdate",
+ "description": "A description of the update."
}
- },
- "id": "UpdateClusterRequest"
+ }
},
"Cluster": {
- "description": "A Google Kubernetes Engine cluster.",
+ "description": "A Google Container Engine cluster.",
"type": "object",
"properties": {
- "addonsConfig": {
- "description": "Configurations for the various addons available to run in the cluster.",
- "$ref": "AddonsConfig"
- },
"status": {
+ "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",
@@ -383,39 +1942,31 @@
"ERROR"
],
"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."
- ]
- },
- "subnetwork": {
- "type": "string",
- "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": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "The resource labels for the cluster to use to annotate any related\nGoogle Compute Engine resources."
+ "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": {
+ "$ref": "MaintenancePolicy",
+ "description": "Configure the maintenance policy for this cluster."
+ },
"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"
@@ -429,16 +1980,16 @@
"type": "string"
},
"legacyAbac": {
- "$ref": "LegacyAbac",
- "description": "Configuration for the legacy ABAC authorization mode."
+ "description": "Configuration for the legacy ABAC authorization mode.",
+ "$ref": "LegacyAbac"
},
"createTime": {
- "type": "string",
- "description": "[Output only] The time the cluster was created, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
+ "description": "[Output only] The time the cluster was created, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
},
"clusterIpv4Cidr": {
- "description": "The IP address range of the container pods in this cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`). Leave blank to have\none automatically chosen or specify a `/14` block in `10.0.0.0/8`.",
- "type": "string"
+ "type": "string",
+ "description": "The IP address range of the container pods in this cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`). Leave blank to have\none automatically chosen or specify a `/14` block in `10.0.0.0/8`."
},
"initialNodeCount": {
"description": "The number of nodes to create in this cluster. 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.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"node_config\") 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.",
@@ -446,8 +1997,8 @@
"type": "integer"
},
"selfLink": {
- "type": "string",
- "description": "[Output only] Server-defined URL for the resource."
+ "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.",
@@ -475,12 +2026,12 @@
"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"
+ "type": "string",
+ "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."
},
"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"
+ "type": "boolean",
+ "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."
},
"description": {
"description": "An optional description of this cluster.",
@@ -492,23 +2043,23 @@
"type": "integer"
},
"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.\n* if left as an empty string, `monitoring.googleapis.com` will be used.",
- "type": "string"
+ "type": "string",
+ "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.\n* if left as an empty string, `monitoring.googleapis.com` will be used."
},
"network": {
- "description": "The name of the Google Compute Engine\n[network](/compute/docs/networks-and-firewalls#networks) to which the\ncluster is connected. If left unspecified, the `default` network\nwill be used.",
- "type": "string"
+ "type": "string",
+ "description": "The name of the Google Compute Engine\n[network](/compute/docs/networks-and-firewalls#networks) to which the\ncluster is connected. If left unspecified, the `default` network\nwill be used."
},
"labelFingerprint": {
- "type": "string",
- "description": "The fingerprint of the set of labels for this cluster."
+ "description": "The fingerprint of the set of labels for this cluster.",
+ "type": "string"
},
"zone": {
"description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.",
"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.",
+ "loggingService": {
+ "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"
},
"nodeIpv4CidrSize": {
@@ -516,8 +2067,8 @@
"format": "int32",
"type": "integer"
},
- "loggingService": {
- "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.",
+ "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": {
@@ -529,38 +2080,52 @@
"type": "string"
},
"masterAuth": {
- "description": "The authentication information for accessing the master endpoint.",
- "$ref": "MasterAuth"
+ "$ref": "MasterAuth",
+ "description": "The authentication information for accessing the master endpoint."
},
"currentMasterVersion": {
- "type": "string",
- "description": "[Output only] The current software version of the master endpoint."
+ "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": {
+ "$ref": "AddonsConfig",
+ "description": "Configurations for the various addons available to run in the cluster."
}
},
"id": "Cluster"
},
"CreateNodePoolRequest": {
+ "id": "CreateNodePoolRequest",
"description": "CreateNodePoolRequest creates a node pool for a cluster.",
"type": "object",
"properties": {
"nodePool": {
- "description": "The node pool to create.",
- "$ref": "NodePool"
+ "$ref": "NodePool",
+ "description": "The node pool to create."
}
- },
- "id": "CreateNodePoolRequest"
+ }
},
"MasterAuth": {
- "description": "The authentication information for accessing the master endpoint.\nAuthentication can be done using HTTP basic auth or using client\ncertificates.",
- "type": "object",
"properties": {
+ "clientCertificateConfig": {
+ "$ref": "ClientCertificateConfig",
+ "description": "Configuration for client certificate authentication on the cluster. If no\nconfiguration is specified, a client certificate is issued."
+ },
+ "password": {
+ "description": "The password to use for HTTP basic authentication to the master endpoint.\nBecause the master endpoint is open to the Internet, you should create a\nstrong password. If a password is provided for cluster creation, username\nmust be non-empty.",
+ "type": "string"
+ },
+ "clientKey": {
+ "description": "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint.",
+ "type": "string"
+ },
"clusterCaCertificate": {
- "type": "string",
- "description": "[Output only] Base64-encoded public certificate that is the root of\ntrust for the cluster."
+ "description": "[Output only] Base64-encoded public certificate that is the root of\ntrust for the cluster.",
+ "type": "string"
},
"clientCertificate": {
"description": "[Output only] Base64-encoded public certificate used by clients to\nauthenticate to the cluster endpoint.",
@@ -569,25 +2134,13 @@
"username": {
"description": "The username to use for HTTP basic authentication to the master endpoint.\nFor clusters v1.6.0 and later, you can disable basic authentication by\nproviding an empty username.",
"type": "string"
- },
- "password": {
- "description": "The password to use for HTTP basic authentication to the master endpoint.\nBecause the master endpoint is open to the Internet, you should create a\nstrong password. If a password is provided for cluster creation, username\nmust be non-empty.",
- "type": "string"
- },
- "clientCertificateConfig": {
- "$ref": "ClientCertificateConfig",
- "description": "Configuration for client certificate authentication on the cluster. If no\nconfiguration is specified, a client certificate is issued."
- },
- "clientKey": {
- "description": "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint.",
- "type": "string"
}
},
- "id": "MasterAuth"
+ "id": "MasterAuth",
+ "description": "The authentication information for accessing the master endpoint.\nAuthentication can be done using HTTP basic auth or using client\ncertificates.",
+ "type": "object"
},
"DailyMaintenanceWindow": {
- "description": "Time window specified for daily maintenance operations.",
- "type": "object",
"properties": {
"duration": {
"description": "[Output only] Duration of the time window, automatically chosen to be\nsmallest possible in the given scenario.\nDuration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)\nformat \"PTnHnMnS\".",
@@ -598,7 +2151,20 @@
"type": "string"
}
},
- "id": "DailyMaintenanceWindow"
+ "id": "DailyMaintenanceWindow",
+ "description": "Time window specified for daily maintenance operations.",
+ "type": "object"
+ },
+ "MaintenancePolicy": {
+ "properties": {
+ "window": {
+ "description": "Specifies the maintenance window in which maintenance may be performed.",
+ "$ref": "MaintenanceWindow"
+ }
+ },
+ "id": "MaintenancePolicy",
+ "description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.",
+ "type": "object"
},
"ClientCertificateConfig": {
"description": "Configuration for client certificates on the cluster.",
@@ -611,17 +2177,6 @@
},
"id": "ClientCertificateConfig"
},
- "MaintenancePolicy": {
- "properties": {
- "window": {
- "$ref": "MaintenanceWindow",
- "description": "Specifies the maintenance window in which maintenance may be performed."
- }
- },
- "id": "MaintenancePolicy",
- "description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.",
- "type": "object"
- },
"SetLoggingServiceRequest": {
"description": "SetLoggingServiceRequest sets the logging service of a cluster.",
"type": "object",
@@ -634,23 +2189,25 @@
"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."
+ "description": "The maintenance policy to be set for the cluster. An empty field\nclears the existing maintenance policy.",
+ "$ref": "MaintenancePolicy"
}
},
- "id": "SetMaintenancePolicyRequest"
+ "id": "SetMaintenancePolicyRequest",
+ "description": "SetMaintenancePolicyRequest sets the maintenance policy for a cluster.",
+ "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"
+ "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 `{}`."
},
"ListNodePoolsResponse": {
+ "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.",
+ "type": "object",
"properties": {
"nodePools": {
"description": "A list of node pools for a cluster.",
@@ -660,9 +2217,7 @@
}
}
},
- "id": "ListNodePoolsResponse",
- "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.",
- "type": "object"
+ "id": "ListNodePoolsResponse"
},
"CompleteIPRotationRequest": {
"type": "object",
@@ -671,24 +2226,41 @@
"description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode."
},
"StartIPRotationRequest": {
- "properties": {},
- "id": "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"
+ "type": "object",
+ "properties": {},
+ "id": "StartIPRotationRequest"
+ },
+ "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": {
+ "resourceLabels": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The labels to set for that cluster."
+ },
+ "labelFingerprint": {
+ "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nContainer 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"
},
"NodePool": {
- "id": "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": {
"autoscaling": {
- "$ref": "NodePoolAutoscaling",
- "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present."
+ "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present.",
+ "$ref": "NodePoolAutoscaling"
},
"initialNodeCount": {
+ "type": "integer",
"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"
+ "format": "int32"
},
"management": {
"description": "NodeManagement configuration for this NodePool.",
@@ -743,29 +2315,10 @@
"description": "The name of the node pool.",
"type": "string"
}
- }
- },
- "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": {
- "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"
+ "id": "NodePool"
},
"NodeManagement": {
- "description": "NodeManagement defines the set of node management services turned on for the\nnode pool.",
- "type": "object",
"properties": {
"autoUpgrade": {
"description": "A flag that specifies whether node auto-upgrade is enabled for the node\npool. If enabled, node auto-upgrade helps keep the nodes in your node pool\nup to date with the latest release version of Kubernetes.",
@@ -776,11 +2329,13 @@
"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"
+ "id": "NodeManagement",
+ "description": "NodeManagement defines the set of node management services turned on for the\nnode pool.",
+ "type": "object"
},
"CancelOperationRequest": {
"type": "object",
@@ -800,9 +2355,48 @@
"id": "KubernetesDashboard"
},
"Operation": {
+ "id": "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": {
+ "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": {
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "PENDING",
+ "RUNNING",
+ "DONE",
+ "ABORTING"
+ ],
+ "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."
+ ]
+ },
+ "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"
+ },
"endTime": {
"description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"type": "string"
@@ -816,6 +2410,7 @@
"type": "string"
},
"operationType": {
+ "type": "string",
"enumDescriptions": [
"Not set.",
"Cluster create.",
@@ -854,60 +2449,20 @@
"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.",
- "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"
- },
- "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"
+ "description": "The operation type."
}
- },
- "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"
+ "id": "MaintenanceWindow",
+ "description": "MaintenanceWindow defines the maintenance window to be used for the cluster.",
+ "type": "object"
},
"RollbackNodePoolUpgradeRequest": {
"description": "RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed\nNodePool upgrade. This will be an no-op if the last upgrade successfully\ncompleted.",
@@ -916,6 +2471,7 @@
"id": "RollbackNodePoolUpgradeRequest"
},
"NetworkPolicy": {
+ "id": "NetworkPolicy",
"description": "Configuration options for the NetworkPolicy feature.\nhttps://kubernetes.io/docs/concepts/services-networking/networkpolicies/",
"type": "object",
"properties": {
@@ -924,1590 +2480,34 @@
"type": "boolean"
},
"provider": {
- "enumDescriptions": [
- "Not set",
- "Tigera (Calico Felix)."
- ],
"enum": [
"PROVIDER_UNSPECIFIED",
"CALICO"
],
"description": "The selected network policy provider.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Not set",
+ "Tigera (Calico Felix)."
+ ]
}
- },
- "id": "NetworkPolicy"
+ }
},
"UpdateMasterRequest": {
"description": "UpdateMasterRequest updates the master of the cluster.",
"type": "object",
"properties": {
"masterVersion": {
- "description": "The Kubernetes version to change the master to. Use \"-\" to have the server\nautomatically select the default version.",
+ "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"
}
},
"id": "UpdateMasterRequest"
- },
- "ListOperationsResponse": {
- "type": "object",
- "properties": {
- "operations": {
- "description": "A list of operations in the project in the specified zone.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- },
- "missingZones": {
- "description": "If any zones are listed here, the list of operations returned\nmay be missing the operations from those zones.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ListOperationsResponse",
- "description": "ListOperationsResponse is the result of ListOperationsRequest."
- },
- "SetMonitoringServiceRequest": {
- "id": "SetMonitoringServiceRequest",
- "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"
- }
- }
- },
- "CidrBlock": {
- "description": "CidrBlock contains an optional name and one CIDR block.",
- "type": "object",
- "properties": {
- "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"
- },
- "ServerConfig": {
- "type": "object",
- "properties": {
- "validMasterVersions": {
- "description": "List of valid master versions.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "defaultClusterVersion": {
- "description": "Version of Kubernetes the service deploys by default.",
- "type": "string"
- },
- "defaultImageType": {
- "description": "Default image type.",
- "type": "string"
- },
- "validNodeVersions": {
- "description": "List of valid node upgrade target versions.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "validImageTypes": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "List of valid image types."
- }
- },
- "id": "ServerConfig",
- "description": "Kubernetes Engine service configuration."
- },
- "NodeConfig": {
- "description": "Parameters that describe the nodes in a cluster.",
- "type": "object",
- "properties": {
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the four reserved keys:\n\"instance-template\", \"kube-env\", \"startup-script\", and \"user-data\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
- "type": "object"
- },
- "tags": {
- "description": "The list of instance tags applied to all nodes. Tags are used to identify\nvalid sources or targets for network firewalls and are specified by\nthe client during cluster or node pool creation. Each tag within the list\nmust comply with RFC1035.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "serviceAccount": {
- "description": "The Google Cloud Platform Service Account to be used by the node VMs. If\nno Service Account is specified, the \"default\" service account is used.",
- "type": "string"
- },
- "imageType": {
- "description": "The image type to use for this node. Note that for a given image type,\nthe latest version of it will be used.",
- "type": "string"
- },
- "oauthScopes": {
- "description": "The set of Google API scopes to be made available on all of the\nnode VMs under the \"default\" service account.\n\nThe following scopes are recommended, but not required, and by default are\nnot included:\n\n* `https://www.googleapis.com/auth/compute` is required for mounting\npersistent storage on your nodes.\n* `https://www.googleapis.com/auth/devstorage.read_only` is required for\ncommunicating with **gcr.io**\n(the [Google Container Registry](/container-registry/)).\n\nIf unspecified, no scopes are added, unless Cloud Logging or Cloud\nMonitoring are enabled, in which case their required scopes will be added.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "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": {
- "type": "string",
- "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)"
- },
- "preemptible": {
- "type": "boolean",
- "description": "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninformation about preemptible VM instances."
- },
- "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"
- },
- "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": {
- "clusters": {
- "description": "A list of clusters in the project in the specified zone, or\nacross all ones.",
- "type": "array",
- "items": {
- "$ref": "Cluster"
- }
- },
- "missingZones": {
- "description": "If any zones are listed here, the list of clusters returned\nmay be missing those zones.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ListClustersResponse"
}
},
- "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": "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": {
- "flatPath": "v1/projects/{projectId}/zones/{zone}/serverconfig",
- "id": "container.projects.zones.getServerconfig",
- "path": "v1/projects/{projectId}/zones/{zone}/serverconfig",
- "description": "Returns configuration info about the Kubernetes Engine service.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ServerConfig"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "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 [zone](/compute/docs/zones#available)\nto return operations for.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- },
- "resources": {
- "operations": {
- "methods": {
- "cancel": {
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Cancels the specified operation.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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 operation resides.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "operationId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The server-assigned `name` of the operation."
- }
- },
- "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": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "httpMethod": "GET",
- "parameters": {
- "zone": {
- "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",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
- "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}",
- "id": "container.projects.zones.operations.get"
- }
- }
- },
- "clusters": {
- "methods": {
- "completeIpRotation": {
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
- },
- "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",
- "description": "Completes master IP rotation.",
- "request": {
- "$ref": "CompleteIPRotationRequest"
- }
- },
- "legacyAbac": {
- "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": {
- "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",
- "request": {
- "$ref": "SetLegacyAbacRequest"
- },
- "description": "Enables or disables the ABAC authorization mechanism on a cluster."
- },
- "setNetworkPolicy": {
- "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",
- "description": "Enables/Disables Network Policy for a cluster.",
- "request": {
- "$ref": "SetNetworkPolicyRequest"
- }
- },
- "get": {
- "path": "v1/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).",
- "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 retrieve.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}"
- },
- "startIpRotation": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "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"
- },
- "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"
- }
- },
- "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",
- "request": {
- "$ref": "StartIPRotationRequest"
- },
- "description": "Start master IP rotation."
- },
- "setMaintenancePolicy": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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"
- },
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
- "path": "v1/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": {
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
- "id": "container.projects.zones.clusters.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).",
- "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"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons"
- },
- "delete": {
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "path": "v1/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.",
- "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).",
- "required": true,
- "type": "string"
- },
- "zone": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
- },
- "clusterId": {
- "description": "The name of the cluster to delete.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "locations": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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"
- },
- "projectId": {
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
- "id": "container.projects.zones.clusters.locations",
- "description": "Sets the locations of a specific cluster.",
- "request": {
- "$ref": "SetLocationsRequest"
- }
- },
- "update": {
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.update",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "request": {
- "$ref": "UpdateClusterRequest"
- },
- "description": "Updates the settings of a specific cluster.",
- "httpMethod": "PUT",
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster to upgrade."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "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": {
- "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"
- ]
- },
- "master": {
- "request": {
- "$ref": "UpdateMasterRequest"
- },
- "description": "Updates the master 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}/master",
- "id": "container.projects.zones.clusters.master",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master"
- },
- "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": {
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster to upgrade."
- }
- },
- "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": {
- "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",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
- "id": "container.projects.zones.clusters.logging"
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "response": {
- "$ref": "ListClustersResponse"
- },
- "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, 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",
- "description": "Lists all clusters owned by a project in either the specified zone or all\nzones."
- },
- "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"
- },
- "resourceLabels": {
- "request": {
- "$ref": "SetLabelsRequest"
- },
- "description": "Sets labels on a cluster.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "clusterId": {
- "description": "The name of the cluster.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
- "id": "container.projects.zones.clusters.resourceLabels"
- }
- },
- "resources": {
- "nodePools": {
- "methods": {
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "response": {
- "$ref": "NodePool"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool.",
- "required": true,
- "type": "string"
- },
- "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}/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": {
- "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"
- }
- },
- "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"
- }
- },
- "setSize": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
- },
- "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"
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to update.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize",
- "id": "container.projects.zones.clusters.nodePools.setSize",
- "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize",
- "request": {
- "$ref": "SetNodePoolSizeRequest"
- },
- "description": "Sets the size of a specific node pool."
- },
- "setManagement": {
- "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",
- "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": {
- "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"
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to update.",
- "required": true,
- "type": "string"
- }
- }
- },
- "delete": {
- "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": {
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster."
- },
- "nodePoolId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the node pool to delete."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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."
- },
- "list": {
- "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}/nodePools",
- "path": "v1/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"
- },
- "rollback": {
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
- },
- "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"
- }
- },
- "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",
- "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": {
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- },
- "autoscaling": {
- "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": {
- "description": "The name of the cluster to upgrade.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "nodePoolId": {
- "description": "The name of the node pool 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."
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "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."
- },
- "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": {
- "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"
- },
- "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"
- }
- },
- "version": "v1",
- "baseUrl": "https://container.googleapis.com/",
- "description": "The Google Kubernetes Engine API is used for building and managing container based applications, powered by the open source Kubernetes technology.",
- "kind": "discovery#restDescription",
- "servicePath": "",
- "basePath": "",
- "revision": "20171127",
- "documentationLink": "https://cloud.google.com/container-engine/",
- "id": "container:v1"
+ "icons": {
+ "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/container/v1/container-gen.go b/container/v1/container-gen.go
index ada5877..dda056b 100644
--- a/container/v1/container-gen.go
+++ b/container/v1/container-gen.go
@@ -329,7 +329,7 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// Cluster: A Google Kubernetes Engine cluster.
+// Cluster: A Google Container Engine cluster.
type Cluster struct {
// AddonsConfig: Configurations for the various addons available to run
// in the cluster.
@@ -1914,7 +1914,7 @@
type RollbackNodePoolUpgradeRequest struct {
}
-// ServerConfig: Kubernetes Engine service configuration.
+// ServerConfig: Container Engine service configuration.
type ServerConfig struct {
// DefaultClusterVersion: Version of Kubernetes the service deploys by
// default.
@@ -2002,7 +2002,7 @@
// this resource,
// used to detect conflicts. The fingerprint is initially generated
// by
- // Kubernetes Engine and changes after every request to modify or
+ // Container Engine and changes after every request to modify or
// update
// labels. You must always provide an up-to-date fingerprint hash
// when
@@ -2409,9 +2409,11 @@
// UpdateMasterRequest: UpdateMasterRequest updates the master of the
// cluster.
type UpdateMasterRequest struct {
- // MasterVersion: The Kubernetes version to change the master to. Use
- // "-" to have the server
- // automatically select the default version.
+ // MasterVersion: The Kubernetes version to change the master to. The
+ // only valid value is the
+ // latest supported version. Use "-" to have the server automatically
+ // select
+ // the latest version.
MasterVersion string `json:"masterVersion,omitempty"`
// ForceSendFields is a list of field names (e.g. "MasterVersion") to
@@ -2484,7 +2486,7 @@
header_ http.Header
}
-// GetServerconfig: Returns configuration info about the Kubernetes
+// GetServerconfig: Returns configuration info about the Container
// Engine service.
func (r *ProjectsZonesService) GetServerconfig(projectId string, zone string) *ProjectsZonesGetServerconfigCall {
c := &ProjectsZonesGetServerconfigCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -2588,7 +2590,7 @@
}
return ret, nil
// {
- // "description": "Returns configuration info about the Kubernetes Engine service.",
+ // "description": "Returns configuration info about the Container Engine service.",
// "flatPath": "v1/projects/{projectId}/zones/{zone}/serverconfig",
// "httpMethod": "GET",
// "id": "container.projects.zones.getServerconfig",
diff --git a/container/v1beta1/container-api.json b/container/v1beta1/container-api.json
index 653643f..3b79291 100644
--- a/container/v1beta1/container-api.json
+++ b/container/v1beta1/container-api.json
@@ -1,2288 +1,486 @@
{
- "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": {
- "required": true,
- "type": "string",
- "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."
- }
- },
- "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": {
- "clusters": {
- "methods": {
- "update": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.update",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "request": {
- "$ref": "UpdateClusterRequest"
- },
- "description": "Updates the settings of a specific cluster.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "response": {
- "$ref": "Operation"
- }
- },
- "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": {
- "zone": {
- "required": true,
- "type": "string",
- "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."
- },
- "clusterId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead."
- },
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring",
- "id": "container.projects.zones.clusters.monitoring"
- },
- "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": {
- "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}/master",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
- "id": "container.projects.zones.clusters.master"
- },
- "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.\nModify basic_auth.csv and reset the K8S API server.",
- "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).\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}: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": {
- "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.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead."
- }
- }
- },
- "list": {
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
- "path": "v1beta1/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.",
- "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).\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, 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"
- }
- }
- },
- "resourceLabels": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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"
- },
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
- "id": "container.projects.zones.clusters.resourceLabels",
- "description": "Sets labels on a cluster.",
- "request": {
- "$ref": "SetLabelsRequest"
- }
- },
- "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": {
- "required": true,
- "type": "string",
- "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."
- },
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
- "id": "container.projects.zones.clusters.create"
- },
- "completeIpRotation": {
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
- "id": "container.projects.zones.clusters.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": {
- "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"
- },
- "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"
- }
- }
- },
- "get": {
- "response": {
- "$ref": "Cluster"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "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"
- }
- },
- "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.get",
- "description": "Gets the details of a specific cluster."
- },
- "legacyAbac": {
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac",
- "id": "container.projects.zones.clusters.legacyAbac",
- "description": "Enables or disables the ABAC authorization mechanism on a cluster.",
- "request": {
- "$ref": "SetLegacyAbacRequest"
- },
- "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 update.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac"
- },
- "setNetworkPolicy": {
- "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",
- "request": {
- "$ref": "SetNetworkPolicyRequest"
- },
- "description": "Enables/Disables Network Policy for a cluster."
- },
- "startIpRotation": {
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
- "id": "container.projects.zones.clusters.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).\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "zone": {
- "required": true,
- "type": "string",
- "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."
- },
- "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"
- },
- "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).\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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
- "id": "container.projects.zones.clusters.addons",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons"
- },
- "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": {
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster to update."
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy",
- "id": "container.projects.zones.clusters.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": {
- "name": {
- "location": "query",
- "description": "The name (project, location, cluster) of the cluster to delete.\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.",
- "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 delete.\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}",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
- "id": "container.projects.zones.clusters.delete"
- },
- "locations": {
- "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.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- },
- "clusterId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead."
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
- "id": "container.projects.zones.clusters.locations",
- "description": "Sets the locations of a specific cluster.",
- "request": {
- "$ref": "SetLocationsRequest"
- }
- }
- },
- "resources": {
- "nodePools": {
- "methods": {
- "update": {
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
- "id": "container.projects.zones.clusters.nodePools.update",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
- "request": {
- "$ref": "UpdateNodePoolRequest"
- },
- "description": "Updates the version and/or iamge type of a specific node pool.",
- "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": {
- "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"
- ]
- },
- "setManagement": {
- "parameters": {
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to update.\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": {
- "required": true,
- "type": "string",
- "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."
- },
- "clusterId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster to update.\nThis field is deprecated, use name instead."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
- "id": "container.projects.zones.clusters.nodePools.setManagement",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement",
- "request": {
- "$ref": "SetNodePoolManagementRequest"
- },
- "description": "Sets the NodeManagement options for a node pool.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "response": {
- "$ref": "Operation"
- }
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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": {
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster.\nThis field is deprecated, use name instead."
- },
- "nodePoolId": {
- "location": "path",
- "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string"
- }
- },
- "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."
- },
- "list": {
- "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": {
- "zone": {
- "required": true,
- "type": "string",
- "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."
- },
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "parent": {
- "type": "string",
- "location": "query",
- "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
- },
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools"
- },
- "rollback": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "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"
- },
- "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"
- ],
- "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": {
- "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": {
- "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",
- "path": "v1beta1/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.",
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead."
- },
- "nodePoolId": {
- "description": "The name of the node pool to upgrade.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
- "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.get",
- "description": "Retrieves the node pool requested.",
- "response": {
- "$ref": "NodePool"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "clusterId",
- "nodePoolId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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": {
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The name of the cluster.\nThis field is deprecated, use name instead."
- },
- "nodePoolId": {
- "description": "The name of the node pool.\nThis field is deprecated, use name instead.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
- },
- "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.\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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
- "id": "container.projects.zones.operations.cancel",
- "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel"
- },
- "list": {
- "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.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "projectId",
- "zone"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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"
- },
- "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"
- }
- }
- },
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "zone",
- "operationId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
- "type": "string",
- "location": "query"
- },
- "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"
- }
- },
- "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."
- }
- }
- }
- }
- },
- "locations": {
- "methods": {
- "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": {
- "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": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverConfig",
- "path": "v1beta1/{+name}/serverConfig",
- "id": "container.projects.locations.getServerConfig"
- }
- },
- "resources": {
- "operations": {
- "methods": {
- "cancel": {
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Cancels the specified operation.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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",
- "id": "container.projects.locations.operations.cancel",
- "path": "v1beta1/{+name}:cancel"
- },
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "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."
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
- "required": true,
- "type": "string"
- },
- "operationId": {
- "location": "query",
- "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "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": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
- "path": "v1beta1/{+name}",
- "id": "container.projects.locations.operations.get",
- "description": "Gets the specified operation."
- }
- }
- },
- "clusters": {
- "resources": {
- "nodePools": {
- "methods": {
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
- "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"
- }
- },
- "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": {
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setAutoscaling",
- "id": "container.projects.locations.clusters.nodePools.setAutoscaling",
- "path": "v1beta1/{+name}:setAutoscaling",
- "request": {
- "$ref": "SetNodePoolAutoscalingRequest"
- },
- "description": "Sets the autoscaling settings of a specific node pool.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "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": {
- "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 to delete.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
- "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"
- },
- "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": {
- "type": "string",
- "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."
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
- "path": "v1beta1/{+name}",
- "id": "container.projects.locations.clusters.nodePools.delete"
- },
- "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": {
- "location": "path",
- "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/[^/]+$"
- }
- }
- },
- "list": {
- "description": "Lists the node pools for a cluster.",
- "response": {
- "$ref": "ListNodePoolsResponse"
- },
- "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://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": {
- "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools",
- "path": "v1beta1/{+parent}/nodePools",
- "id": "container.projects.locations.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": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback",
- "id": "container.projects.locations.clusters.nodePools.rollback",
- "path": "v1beta1/{+name}:rollback"
- },
- "create": {
- "id": "container.projects.locations.clusters.nodePools.create",
- "path": "v1beta1/{+parent}/nodePools",
- "request": {
- "$ref": "CreateNodePoolRequest"
- },
- "description": "Creates a node pool for a cluster.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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"
- },
- "get": {
- "response": {
- "$ref": "NodePool"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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": {
- "type": "string",
- "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."
- },
- "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.\nThis field is deprecated, use name instead.",
- "type": "string"
- }
- },
- "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."
- }
- }
- }
- },
- "methods": {
- "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": {
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
- "path": "v1beta1/{+name}",
- "id": "container.projects.locations.clusters.update"
- },
- "setMasterAuth": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path",
- "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth",
- "path": "v1beta1/{+name}:setMasterAuth",
- "id": "container.projects.locations.clusters.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": {
- "path": "v1beta1/{+name}:setLogging",
- "id": "container.projects.locations.clusters.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"
- },
- "list": {
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
- "id": "container.projects.locations.clusters.list",
- "path": "v1beta1/{+parent}/clusters",
- "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListClustersResponse"
- },
- "parameters": {
- "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": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "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"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "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": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
- "path": "v1beta1/{+parent}/clusters",
- "id": "container.projects.locations.clusters.create"
- },
- "completeIpRotation": {
- "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"
- },
- "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 complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
- }
- }
- },
- "setNetworkPolicy": {
- "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"
- ],
- "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."
- },
- "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": {
- "location": "query",
- "description": "The name of the cluster to retrieve.\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}",
- "id": "container.projects.locations.clusters.get",
- "path": "v1beta1/{+name}",
- "description": "Gets the details of a specific cluster."
- },
- "setAddons": {
- "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"
- }
- },
- "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"
- }
- },
- "startIpRotation": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "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",
- "path": "v1beta1/{+name}:startIpRotation",
- "id": "container.projects.locations.clusters.startIpRotation",
- "request": {
- "$ref": "StartIPRotationRequest"
- },
- "description": "Start master IP rotation."
- },
- "setMonitoring": {
- "description": "Sets the monitoring service of a specific cluster.",
- "request": {
- "$ref": "SetMonitoringServiceRequest"
- },
- "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 monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMonitoring",
- "path": "v1beta1/{+name}:setMonitoring",
- "id": "container.projects.locations.clusters.setMonitoring"
- },
- "setMaintenancePolicy": {
- "path": "v1beta1/{+name}:setMaintenancePolicy",
- "id": "container.projects.locations.clusters.setMaintenancePolicy",
- "description": "Sets the maintenance policy for a cluster.",
- "request": {
- "$ref": "SetMaintenancePolicyRequest"
- },
- "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 maintenance\npolicy.\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}:setMaintenancePolicy"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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": {
- "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": {
- "type": "string",
- "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."
- },
- "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"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
- "id": "container.projects.locations.clusters.delete",
- "path": "v1beta1/{+name}",
- "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."
- },
- "setResourceLabels": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "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/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setResourceLabels",
- "path": "v1beta1/{+name}:setResourceLabels",
- "id": "container.projects.locations.clusters.setResourceLabels",
- "description": "Sets labels on a cluster.",
- "request": {
- "$ref": "SetLabelsRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST"
- },
- "setLegacyAbac": {
- "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"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "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"
- }
- }
- },
- "updateMaster": {
- "description": "Updates the master of a specific cluster.",
- "request": {
- "$ref": "UpdateMasterRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
- "location": "path",
- "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:updateMaster",
- "path": "v1beta1/{+name}:updateMaster",
- "id": "container.projects.locations.clusters.updateMaster"
- },
- "setLocations": {
- "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",
- "description": "Sets the locations of a specific cluster.",
- "request": {
- "$ref": "SetLocationsRequest"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "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": {
- "type": "boolean",
- "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": {
- "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"
- },
- "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": {
- "location": "query",
- "description": "JSONP",
- "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."
- }
- },
- "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": "",
- "basePath": "",
"id": "container:v1beta1",
"documentationLink": "https://cloud.google.com/container-engine/",
- "revision": "20171127",
+ "revision": "20171111",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "NodeTaint": {
+ "description": "Kubernetes taint is comprised of three fields: key, value, and effect. Effect\ncan only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.\n\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/configuration/taint-and-toleration/",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Value for taint.",
+ "type": "string"
+ },
+ "effect": {
+ "enumDescriptions": [
+ "Not set",
+ "NoSchedule",
+ "PreferNoSchedule",
+ "NoExecute"
+ ],
+ "enum": [
+ "EFFECT_UNSPECIFIED",
+ "NO_SCHEDULE",
+ "PREFER_NO_SCHEDULE",
+ "NO_EXECUTE"
+ ],
+ "description": "Effect for taint.",
+ "type": "string"
+ },
+ "key": {
+ "description": "Key for taint.",
+ "type": "string"
+ }
+ },
+ "id": "NodeTaint"
+ },
+ "SetLegacyAbacRequest": {
+ "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"
+ },
+ "projectId": {
+ "type": "string",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead."
+ },
+ "zone": {
+ "type": "string",
+ "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."
+ },
+ "clusterId": {
+ "type": "string",
+ "description": "The name of the cluster to update.\nThis field is deprecated, use name instead."
+ }
+ },
+ "id": "SetLegacyAbacRequest",
+ "description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for\na cluster."
+ },
+ "AddonsConfig": {
+ "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": {
+ "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"
+ }
+ },
+ "id": "AddonsConfig"
+ },
+ "SetLocationsRequest": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to set locations.\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"
+ },
+ "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"
+ },
+ "locations": {
+ "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"
+ }
+ },
+ "clusterId": {
+ "type": "string",
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead."
+ }
+ },
+ "id": "SetLocationsRequest",
+ "description": "SetLocationsRequest sets the locations of the cluster."
+ },
+ "NetworkPolicyConfig": {
+ "id": "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.",
+ "type": "object",
+ "properties": {
+ "disabled": {
+ "type": "boolean",
+ "description": "Whether NetworkPolicy is enabled for this cluster."
+ }
+ }
+ },
+ "UpdateClusterRequest": {
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "type": "string",
+ "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead."
+ },
+ "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 to upgrade.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "update": {
+ "description": "A description of the update.",
+ "$ref": "ClusterUpdate"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
+ }
+ },
+ "id": "UpdateClusterRequest",
+ "description": "UpdateClusterRequest updates the settings of a cluster."
+ },
+ "Cluster": {
+ "description": "A Google Container Engine cluster.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "$ref": "PodSecurityPolicyConfig",
+ "description": "Configuration for the PodSecurityPolicy feature."
+ },
+ "addonsConfig": {
+ "description": "Configurations for the various addons available to run in the cluster.",
+ "$ref": "AddonsConfig"
+ },
+ "status": {
+ "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"
+ ],
+ "description": "[Output only] The current status of this cluster.",
+ "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"
+ },
+ "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"
+ },
+ "maintenancePolicy": {
+ "$ref": "MaintenancePolicy",
+ "description": "Configure the maintenance policy for this cluster."
+ },
+ "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"
+ },
+ "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"
+ },
+ "createTime": {
+ "description": "[Output only] The time the cluster was created, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
+ "type": "string"
+ },
+ "clusterIpv4Cidr": {
+ "description": "The IP address range of the container pods in this cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`). Leave blank to have\none automatically chosen or specify a `/14` block in `10.0.0.0/8`.",
+ "type": "string"
+ },
+ "initialNodeCount": {
+ "description": "The number of nodes to create in this cluster. 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.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"node_config\") 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.",
+ "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"
+ }
+ },
+ "locations": {
+ "description": "The list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "selfLink": {
+ "description": "[Output only] Server-defined URL for the resource.",
+ "type": "string"
+ },
+ "instanceGroupUrls": {
+ "description": "Deprecated. Use node_pools.instance_group_urls.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "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": {
+ "$ref": "NetworkPolicy",
+ "description": "Configuration options for the NetworkPolicy feature."
+ },
+ "enableKubernetesAlpha": {
+ "description": "Kubernetes alpha features are enabled on this cluster. This includes alpha\nAPI groups (e.g. v1beta1) 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"
+ },
+ "description": {
+ "description": "An optional description of this cluster.",
+ "type": "string"
+ },
+ "currentNodeCount": {
+ "type": "integer",
+ "description": "[Output only] The number of nodes currently in the cluster.",
+ "format": "int32"
+ },
+ "monitoringService": {
+ "type": "string",
+ "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.\n* if left as an empty string, `monitoring.googleapis.com` will be used."
+ },
+ "network": {
+ "description": "The name of the Google Compute Engine\n[network](/compute/docs/networks-and-firewalls#networks) to which the\ncluster is connected. If left unspecified, the `default` network\nwill be used.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use location instead.",
+ "type": "string"
+ },
+ "loggingService": {
+ "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"
+ },
+ "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": "The configuration options for master authorized networks feature.",
+ "$ref": "MasterAuthorizedNetworksConfig"
+ },
+ "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"
+ }
+ },
+ "id": "Cluster"
+ },
+ "CreateNodePoolRequest": {
+ "description": "CreateNodePoolRequest creates a node pool for a cluster.",
+ "type": "object",
+ "properties": {
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
+ "type": "string"
+ },
+ "nodePool": {
+ "$ref": "NodePool",
+ "description": "The node pool to create."
+ },
+ "parent": {
+ "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "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 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"
+ }
+ },
+ "id": "CreateNodePoolRequest"
+ },
+ "MasterAuth": {
+ "description": "The authentication information for accessing the master endpoint.\nAuthentication can be done using HTTP basic auth or using client\ncertificates.",
+ "type": "object",
+ "properties": {
+ "password": {
+ "description": "The password to use for HTTP basic authentication to the master endpoint.\nBecause the master endpoint is open to the Internet, you should create a\nstrong password. If a password is provided for cluster creation, username\nmust be non-empty.",
+ "type": "string"
+ },
+ "clientCertificateConfig": {
+ "$ref": "ClientCertificateConfig",
+ "description": "Configuration for client certificate authentication on the cluster. If no\nconfiguration is specified, a client certificate is issued."
+ },
+ "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"
+ },
+ "clientCertificate": {
+ "description": "[Output only] Base64-encoded public certificate used by clients to\nauthenticate to the cluster endpoint.",
+ "type": "string"
+ },
+ "username": {
+ "description": "The username to use for HTTP basic authentication to the master endpoint.\nFor clusters v1.6.0 and later, you can disable basic authentication by\nproviding an empty username.",
+ "type": "string"
+ }
+ },
+ "id": "MasterAuth"
+ },
+ "DailyMaintenanceWindow": {
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "description": "Time within the maintenance window to start the maintenance operations.\nIt must be in format \"HH:MM”, where HH : [00-23] and MM : [00-59] GMT.",
+ "type": "string"
+ },
+ "duration": {
+ "type": "string",
+ "description": "[Output only] Duration of the time window, automatically chosen to be\nsmallest possible in the given scenario."
+ }
+ },
+ "id": "DailyMaintenanceWindow",
+ "description": "Time window specified for daily maintenance operations."
+ },
+ "MaintenancePolicy": {
+ "type": "object",
+ "properties": {
+ "window": {
+ "description": "Specifies the maintenance window in which maintenance may be performed.",
+ "$ref": "MaintenanceWindow"
+ }
+ },
+ "id": "MaintenancePolicy",
+ "description": "MaintenancePolicy defines the maintenance policy to be used for the cluster."
+ },
+ "ClientCertificateConfig": {
+ "description": "Configuration for client certificates on the cluster.",
+ "type": "object",
+ "properties": {
+ "issueClientCertificate": {
+ "type": "boolean",
+ "description": "Issue a client certificate."
+ }
+ },
+ "id": "ClientCertificateConfig"
+ },
+ "SetLoggingServiceRequest": {
+ "description": "SetLoggingServiceRequest sets the logging service of a cluster.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "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": {
+ "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 `{}`."
+ },
"ListNodePoolsResponse": {
- "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.",
"type": "object",
"properties": {
"nodePools": {
@@ -2293,19 +491,14 @@
}
}
},
- "id": "ListNodePoolsResponse"
+ "id": "ListNodePoolsResponse",
+ "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest."
},
"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"
+ "type": "string",
+ "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."
},
"zone": {
"type": "string",
@@ -2314,14 +507,24 @@
"clusterId": {
"type": "string",
"description": "The name of the cluster.\nThis field is deprecated, use name instead."
+ },
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
}
},
- "id": "CompleteIPRotationRequest"
+ "id": "CompleteIPRotationRequest",
+ "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.",
+ "type": "object"
},
"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"
@@ -2333,53 +536,75 @@
"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"
},
"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.",
+ "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nContainer 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"
},
+ "name": {
+ "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "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"
- },
- "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"
+ "id": "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"
},
"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": {
+ "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"
+ }
+ },
"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.",
@@ -2397,9 +622,7 @@
"RECONCILING",
"STOPPING",
"ERROR"
- ],
- "description": "[Output only] The status of the nodes in this pool instance.",
- "type": "string"
+ ]
},
"config": {
"$ref": "NodeConfig",
@@ -2414,32 +637,8 @@
"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": {
- "$ref": "NodeManagement",
- "description": "NodeManagement configuration for this NodePool."
- },
- "selfLink": {
- "description": "[Output only] Server-defined URL for the resource.",
- "type": "string"
- },
- "version": {
- "type": "string",
- "description": "The version of the Kubernetes of this node."
- },
- "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"
- }
+ "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present.",
+ "$ref": "NodePoolAutoscaling"
}
},
"id": "NodePool"
@@ -2453,12 +652,12 @@
"type": "boolean"
},
"autoRepair": {
- "description": "Whether the nodes will be automatically repaired.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether the nodes will be automatically repaired."
},
"upgradeOptions": {
- "description": "Specifies the Auto Upgrade knobs for the node pool.",
- "$ref": "AutoUpgradeOptions"
+ "$ref": "AutoUpgradeOptions",
+ "description": "Specifies the Auto Upgrade knobs for the node pool."
}
},
"id": "NodeManagement"
@@ -2467,14 +666,6 @@
"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": {
- "type": "string",
- "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead."
- },
"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"
@@ -2482,6 +673,14 @@
"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"
+ },
+ "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"
}
},
"id": "CancelOperationRequest"
@@ -2498,30 +697,61 @@
"id": "KubernetesDashboard"
},
"Operation": {
+ "id": "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": {
+ "zone": {
+ "type": "string",
+ "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."
+ },
+ "status": {
+ "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"
+ ],
+ "description": "The current status of the operation."
+ },
+ "statusMessage": {
+ "description": "If an error has occurred, a textual description of the error.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "The server-assigned ID for the operation."
+ },
"selfLink": {
"description": "Server-defined URL for the resource.",
"type": "string"
},
"detail": {
- "type": "string",
- "description": "Detailed operation progress, if available."
+ "description": "Detailed operation progress, if available.",
+ "type": "string"
},
"targetLink": {
"description": "Server-defined URL for the target of the operation.",
"type": "string"
},
- "location": {
- "type": "string",
- "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."
- },
"endTime": {
"description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"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"
+ },
"operationType": {
- "description": "The operation type.",
- "type": "string",
"enumDescriptions": [
"Not set.",
"Cluster create.",
@@ -2559,122 +789,90 @@
"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": {
- "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"
+ "type": "string",
+ "description": "[Output only] The time the operation started, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
}
- },
- "id": "Operation",
- "description": "This operation resource represents operations that may have happened or are\nhappening on the cluster. All fields are output only.",
- "type": "object"
+ }
},
"MaintenanceWindow": {
- "id": "MaintenanceWindow",
"description": "MaintenanceWindow defines the maintenance window to be used for the cluster.",
"type": "object",
"properties": {
"dailyMaintenanceWindow": {
- "description": "DailyMaintenanceWindow specifies a daily maintenance operation window.",
- "$ref": "DailyMaintenanceWindow"
+ "$ref": "DailyMaintenanceWindow",
+ "description": "DailyMaintenanceWindow specifies a daily maintenance operation window."
}
- }
+ },
+ "id": "MaintenanceWindow"
},
"RollbackNodePoolUpgradeRequest": {
+ "id": "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",
"properties": {
+ "nodePoolId": {
+ "description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
"name": {
- "type": "string",
- "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'."
+ "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
+ "type": "string"
},
"projectId": {
- "type": "string",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead."
+ "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": {
- "type": "string",
- "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."
+ "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 rollback.\nThis field is deprecated, use name instead.",
"type": "string"
- },
- "nodePoolId": {
- "type": "string",
- "description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead."
}
- },
- "id": "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"
+ }
},
"NetworkPolicy": {
"description": "Configuration options for the NetworkPolicy feature.\nhttps://kubernetes.io/docs/concepts/services-networking/networkpolicies/",
"type": "object",
"properties": {
- "enabled": {
- "type": "boolean",
- "description": "Whether network policy is enabled on the cluster."
- },
"provider": {
+ "enumDescriptions": [
+ "Not set",
+ "Tigera (Calico Felix)."
+ ],
"enum": [
"PROVIDER_UNSPECIFIED",
"CALICO"
],
"description": "The selected network policy provider.",
- "type": "string",
- "enumDescriptions": [
- "Not set",
- "Tigera (Calico Felix)."
- ]
+ "type": "string"
+ },
+ "enabled": {
+ "description": "Whether network policy is enabled on the cluster.",
+ "type": "boolean"
}
},
"id": "NetworkPolicy"
},
"UpdateMasterRequest": {
- "type": "object",
"properties": {
"clusterId": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "type": "string"
+ "type": "string",
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead."
},
"name": {
"description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
"type": "string"
},
"projectId": {
- "type": "string",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840)."
+ "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.\nThis field is deprecated, use name instead.",
@@ -2686,19 +884,19 @@
}
},
"id": "UpdateMasterRequest",
- "description": "UpdateMasterRequest updates the master of the cluster."
+ "description": "UpdateMasterRequest updates the master of the cluster.",
+ "type": "object"
},
"ListOperationsResponse": {
- "id": "ListOperationsResponse",
"description": "ListOperationsResponse is the result of ListOperationsRequest.",
"type": "object",
"properties": {
"operations": {
- "description": "A list of operations in the project in the specified zone.",
"type": "array",
"items": {
"$ref": "Operation"
- }
+ },
+ "description": "A list of operations in the project in the specified zone."
},
"missingZones": {
"description": "If any zones are listed here, the list of operations returned\nmay be missing the operations from those zones.",
@@ -2707,22 +905,23 @@
"type": "string"
}
}
- }
+ },
+ "id": "ListOperationsResponse"
},
"CidrBlock": {
+ "description": "CidrBlock contains an optional name and one CIDR block.",
+ "type": "object",
"properties": {
- "cidrBlock": {
- "description": "cidr_block must be specified in CIDR notation.",
+ "displayName": {
+ "description": "display_name is an optional field for users to identify CIDR blocks.",
"type": "string"
},
- "displayName": {
+ "cidrBlock": {
"type": "string",
- "description": "display_name is an optional field for users to identify CIDR blocks."
+ "description": "cidr_block must be specified in CIDR notation."
}
},
- "id": "CidrBlock",
- "description": "CidrBlock contains an optional name and one CIDR block.",
- "type": "object"
+ "id": "CidrBlock"
},
"SetMonitoringServiceRequest": {
"description": "SetMonitoringServiceRequest sets the monitoring service of a cluster.",
@@ -2752,7 +951,7 @@
"id": "SetMonitoringServiceRequest"
},
"ServerConfig": {
- "description": "Kubernetes Engine service configuration.",
+ "description": "Container Engine service configuration.",
"type": "object",
"properties": {
"validMasterVersions": {
@@ -2771,11 +970,11 @@
"type": "string"
},
"validNodeVersions": {
- "description": "List of valid node upgrade target versions.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "List of valid node upgrade target versions."
},
"validImageTypes": {
"description": "List of valid image types.",
@@ -2791,24 +990,13 @@
"description": "Parameters that describe the nodes in a cluster.",
"type": "object",
"properties": {
- "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": {
- "type": "string",
- "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`."
- },
"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": {
- "type": "boolean",
- "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."
+ "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.",
@@ -2816,11 +1004,11 @@
"type": "integer"
},
"metadata": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the four reserved keys:\n\"instance-template\", \"kube-env\", \"startup-script\", and \"user-data\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB.",
- "type": "object"
+ "description": "The metadata key/value pairs assigned to instances in the cluster.\n\nKeys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes\nin length. These are reflected as part of a URL in the metadata server.\nAdditionally, to avoid ambiguity, keys must not conflict with any other\nmetadata keys for the project or be one of the four reserved keys:\n\"instance-template\", \"kube-env\", \"startup-script\", and \"user-data\"\n\nValues are free-form strings, and only have meaning as interpreted by\nthe image running in the instance. The only restriction placed on them is\nthat each value's size must be less than or equal to 32 KB.\n\nThe total size of all keys and values must be less than 512 KB."
},
"tags": {
"description": "The list of instance tags applied to all nodes. Tags are used to identify\nvalid sources or targets for network firewalls and are specified by\nthe client during cluster or node pool creation. Each tag within the list\nmust comply with RFC1035.",
@@ -2862,6 +1050,17 @@
"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"
}
},
"id": "NodeConfig"
@@ -2869,49 +1068,49 @@
"AutoUpgradeOptions": {
"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"
+ },
+ "description": {
+ "description": "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade.",
+ "type": "string"
}
},
"id": "AutoUpgradeOptions",
"description": "AutoUpgradeOptions defines the set of options for the user to control how\nthe Auto Upgrades will proceed."
},
"ListClustersResponse": {
+ "description": "ListClustersResponse is the result of ListClustersRequest.",
"type": "object",
"properties": {
+ "clusters": {
+ "type": "array",
+ "items": {
+ "$ref": "Cluster"
+ },
+ "description": "A list of clusters in the project in the specified zone, or\nacross all ones."
+ },
"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",
- "description": "ListClustersResponse is the result of ListClustersRequest."
+ "id": "ListClustersResponse"
},
"PodSecurityPolicyConfig": {
- "description": "Configuration for the PodSecurityPolicy feature.",
"type": "object",
"properties": {
"enabled": {
- "type": "boolean",
- "description": "Enable the PodSecurityPolicy controller for this cluster. If enabled, pods\nmust be valid under a PodSecurityPolicy to be created."
+ "description": "Enable the PodSecurityPolicy controller for this cluster. If enabled, pods\nmust be valid under a PodSecurityPolicy to be created.",
+ "type": "boolean"
}
},
- "id": "PodSecurityPolicyConfig"
+ "id": "PodSecurityPolicyConfig",
+ "description": "Configuration for the PodSecurityPolicy feature."
},
"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.",
@@ -2924,34 +1123,52 @@
},
"id": "HttpLoadBalancing"
},
- "SetNetworkPolicyRequest": {
- "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.",
+ "SetMasterAuthRequest": {
+ "description": "SetMasterAuthRequest updates the admin password of 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"
+ "update": {
+ "description": "A description of the update.",
+ "$ref": "MasterAuth"
},
"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"
},
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string"
+ },
+ "action": {
+ "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"
+ ],
+ "description": "The exact form of action to be taken on the master auth."
+ },
+ "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.\nThis field is deprecated, use name instead.",
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
"type": "string"
}
},
- "id": "SetNetworkPolicyRequest"
+ "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": {
"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.",
@@ -2968,54 +1185,87 @@
"type": "boolean"
}
},
- "id": "NodePoolAutoscaling",
- "description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage.",
- "type": "object"
+ "id": "NodePoolAutoscaling"
},
- "SetMasterAuthRequest": {
- "description": "SetMasterAuthRequest updates the admin password of a cluster.",
- "type": "object",
+ "SetNetworkPolicyRequest": {
"properties": {
- "update": {
- "$ref": "MasterAuth",
- "description": "A description of the update."
+ "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"
},
- "name": {
- "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
- "type": "string"
- },
- "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"
- ]
- },
- "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.",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ },
+ "networkPolicy": {
+ "description": "Configuration options for the NetworkPolicy feature.",
+ "$ref": "NetworkPolicy"
+ },
+ "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": "SetMasterAuthRequest"
+ "id": "SetNetworkPolicyRequest",
+ "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.",
+ "type": "object"
+ },
+ "ClusterUpdate": {
+ "id": "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": {
+ "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": {
+ "description": "Configurations for the various addons available to run in the cluster.",
+ "$ref": "AddonsConfig"
+ },
+ "desiredNodePoolId": {
+ "type": "string",
+ "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."
+ },
+ "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"
+ },
+ "desiredPodSecurityPolicyConfig": {
+ "description": "The desired configuration options for the PodSecurityPolicy feature.",
+ "$ref": "PodSecurityPolicyConfig"
+ },
+ "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": "The desired configuration options for master authorized networks feature.",
+ "$ref": "MasterAuthorizedNetworksConfig"
+ },
+ "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"
+ },
+ "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"
+ }
+ }
+ }
},
"IPAllocationPolicy": {
+ "id": "IPAllocationPolicy",
"description": "Configuration for controlling how IPs are allocated in the cluster.",
"type": "object",
"properties": {
@@ -3028,8 +1278,8 @@
"type": "boolean"
},
"nodeIpv4Cidr": {
- "type": "string",
- "description": "This field is deprecated, use node_ipv4_cidr_block."
+ "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.",
@@ -3056,71 +1306,21 @@
"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"
+ "type": "string",
+ "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."
},
"clusterIpv4Cidr": {
- "type": "string",
- "description": "This field is deprecated, use cluster_ipv4_cidr_block."
+ "description": "This field is deprecated, use cluster_ipv4_cidr_block.",
+ "type": "string"
},
"servicesIpv4Cidr": {
"description": "This field is deprecated, use services_ipv4_cidr_block.",
"type": "string"
}
- },
- "id": "IPAllocationPolicy"
- },
- "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": {
- "type": "string",
- "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server."
- },
- "desiredPodSecurityPolicyConfig": {
- "description": "The desired configuration options for the PodSecurityPolicy feature.",
- "$ref": "PodSecurityPolicyConfig"
- },
- "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": {
- "$ref": "MasterAuthorizedNetworksConfig",
- "description": "The desired configuration options for master authorized networks feature."
- },
- "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": {
- "type": "string",
- "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"
- },
- "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"
+ }
},
"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": {
@@ -3128,11 +1328,27 @@
"type": "boolean"
}
},
- "id": "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."
+ "id": "HorizontalPodAutoscaling"
+ },
+ "MasterAuthorizedNetworksConfig": {
+ "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",
+ "description": "Configuration 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"
},
"SetNodePoolManagementRequest": {
- "id": "SetNodePoolManagementRequest",
"description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.",
"type": "object",
"properties": {
@@ -3149,8 +1365,8 @@
"type": "string"
},
"management": {
- "$ref": "NodeManagement",
- "description": "NodeManagement configuration for the node pool."
+ "description": "NodeManagement configuration for the node pool.",
+ "$ref": "NodeManagement"
},
"clusterId": {
"description": "The name of the cluster to update.\nThis field is deprecated, use name instead.",
@@ -3160,34 +1376,12 @@
"description": "The name of the node pool to update.\nThis field is deprecated, use name instead.",
"type": "string"
}
- }
- },
- "MasterAuthorizedNetworksConfig": {
- "id": "MasterAuthorizedNetworksConfig",
- "description": "Configuration 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": {
- "type": "boolean",
- "description": "Whether or not master authorized networks is enabled."
- },
- "cidrBlocks": {
- "description": "cidr_blocks define up to 10 external networks that could access\nKubernetes master through HTTPS.",
- "type": "array",
- "items": {
- "$ref": "CidrBlock"
- }
- }
- }
+ },
+ "id": "SetNodePoolManagementRequest"
},
"SetNodePoolAutoscalingRequest": {
- "description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.",
"type": "object",
"properties": {
- "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"
- },
"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/*'.",
"type": "string"
@@ -3207,21 +1401,21 @@
"nodePoolId": {
"description": "The name of the node pool to upgrade.\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"
}
},
- "id": "SetNodePoolAutoscalingRequest"
+ "id": "SetNodePoolAutoscalingRequest",
+ "description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool."
},
"CreateClusterRequest": {
- "description": "CreateClusterRequest creates a cluster.",
"type": "object",
"properties": {
- "parent": {
- "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.",
- "type": "string"
- },
"projectId": {
- "type": "string",
- "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead."
+ "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"
},
"cluster": {
"$ref": "Cluster",
@@ -3230,18 +1424,36 @@
"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"
+ },
+ "parent": {
+ "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.",
+ "type": "string"
}
},
- "id": "CreateClusterRequest"
+ "id": "CreateClusterRequest",
+ "description": "CreateClusterRequest creates a cluster."
+ },
+ "AcceleratorConfig": {
+ "type": "object",
+ "properties": {
+ "acceleratorCount": {
+ "type": "string",
+ "description": "The number of the accelerator cards exposed to an instance.",
+ "format": "int64"
+ },
+ "acceleratorType": {
+ "type": "string",
+ "description": "The accelerator type resource name. List of supported accelerators\n[here](/compute/docs/gpus/#Introduction)"
+ }
+ },
+ "id": "AcceleratorConfig",
+ "description": "AcceleratorConfig represents a Hardware Accelerator request."
},
"UpdateNodePoolRequest": {
+ "id": "UpdateNodePoolRequest",
"description": "SetNodePoolVersionRequest updates the version of a node pool.",
"type": "object",
"properties": {
- "imageType": {
- "type": "string",
- "description": "The desired image type for the node pool."
- },
"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"
@@ -3251,8 +1463,8 @@
"type": "string"
},
"name": {
- "type": "string",
- "description": "The name (project, location, cluster, node pool) of the node pool to update.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'."
+ "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.",
@@ -3263,40 +1475,20 @@
"type": "string"
},
"nodePoolId": {
- "type": "string",
- "description": "The name of the node pool to upgrade.\nThis field is deprecated, use name instead."
- }
- },
- "id": "UpdateNodePoolRequest"
- },
- "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",
+ "description": "The name of the node pool to upgrade.\nThis field is deprecated, use name instead.",
"type": "string"
},
- "acceleratorType": {
- "description": "The accelerator type resource name. List of supported accelerators\n[here](/compute/docs/gpus/#Introduction)",
+ "imageType": {
+ "description": "The desired image type for the node pool.",
"type": "string"
}
- },
- "id": "AcceleratorConfig"
+ }
},
"SetAddonsConfigRequest": {
+ "id": "SetAddonsConfigRequest",
"description": "SetAddonsRequest sets the addons associated with the cluster.",
"type": "object",
"properties": {
- "clusterId": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "addonsConfig": {
- "$ref": "AddonsConfig",
- "description": "The desired configurations for the various addons available to run in the\ncluster."
- },
"name": {
"description": "The name (project, location, cluster) of the cluster to set addons.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
"type": "string"
@@ -3308,491 +1500,23 @@
"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"
- }
- },
- "id": "SetAddonsConfigRequest"
- },
- "NodeTaint": {
- "description": "Kubernetes taint is comprised of three fields: key, value, and effect. Effect\ncan only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.\n\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/configuration/taint-and-toleration/",
- "type": "object",
- "properties": {
- "value": {
- "description": "Value for taint.",
- "type": "string"
- },
- "effect": {
- "description": "Effect for taint.",
- "type": "string",
- "enumDescriptions": [
- "Not set",
- "NoSchedule",
- "PreferNoSchedule",
- "NoExecute"
- ],
- "enum": [
- "EFFECT_UNSPECIFIED",
- "NO_SCHEDULE",
- "PREFER_NO_SCHEDULE",
- "NO_EXECUTE"
- ]
- },
- "key": {
- "description": "Key for taint.",
- "type": "string"
- }
- },
- "id": "NodeTaint"
- },
- "SetLegacyAbacRequest": {
- "description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for\na cluster.",
- "type": "object",
- "properties": {
- "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 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"
- },
- "enabled": {
- "description": "Whether ABAC authorization will be enabled in the cluster.",
- "type": "boolean"
- },
- "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"
- }
- },
- "id": "SetLegacyAbacRequest"
- },
- "AddonsConfig": {
- "description": "Configuration for the addons that can be automatically spun up in the\ncluster, enabling additional functionality.",
- "type": "object",
- "properties": {
- "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."
- },
- "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"
- }
- },
- "id": "AddonsConfig"
- },
- "SetLocationsRequest": {
- "description": "SetLocationsRequest sets the locations of the cluster.",
- "type": "object",
- "properties": {
- "clusterId": {
- "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
- },
- "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.\nThis field is deprecated, use name instead.",
- "type": "string"
- },
- "locations": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "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."
- }
- },
- "id": "SetLocationsRequest"
- },
- "NetworkPolicyConfig": {
- "type": "object",
- "properties": {
- "disabled": {
- "type": "boolean",
- "description": "Whether NetworkPolicy is enabled for this cluster."
- }
- },
- "id": "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."
- },
- "UpdateClusterRequest": {
- "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"
- },
- "zone": {
- "type": "string",
- "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."
},
"clusterId": {
"description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.",
"type": "string"
- }
- },
- "id": "UpdateClusterRequest",
- "description": "UpdateClusterRequest updates the settings of a cluster.",
- "type": "object"
- },
- "Cluster": {
- "description": "A Google Kubernetes Engine 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.\n* if left as an empty string, `monitoring.googleapis.com` will be used.",
- "type": "string"
- },
- "network": {
- "description": "The name of the Google Compute Engine\n[network](/compute/docs/networks-and-firewalls#networks) to which the\ncluster is connected. If left unspecified, the `default` network\nwill be used.",
- "type": "string"
- },
- "zone": {
- "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use location instead.",
- "type": "string"
- },
- "expireTime": {
- "type": "string",
- "description": "[Output only] The time the cluster will be automatically\ndeleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
- },
- "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"
- },
- "loggingService": {
- "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"
- },
- "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": {
- "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"
- },
- "podSecurityPolicyConfig": {
- "description": "Configuration for the PodSecurityPolicy feature.",
- "$ref": "PodSecurityPolicyConfig"
},
"addonsConfig": {
- "description": "Configurations for the various addons available to run in the cluster.",
- "$ref": "AddonsConfig"
- },
- "status": {
- "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"
- ],
- "description": "[Output only] The current status of this cluster."
- },
- "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": {
- "description": "Configure the maintenance policy for this cluster.",
- "$ref": "MaintenancePolicy"
- },
- "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"
- },
- "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"
- },
- "createTime": {
- "description": "[Output only] The time the cluster was created, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
- "type": "string"
- },
- "clusterIpv4Cidr": {
- "description": "The IP address range of the container pods in this cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`). Leave blank to have\none automatically chosen or specify a `/14` block in `10.0.0.0/8`.",
- "type": "string"
- },
- "initialNodeCount": {
- "type": "integer",
- "description": "The number of nodes to create in this cluster. 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.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"node_config\") 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.",
- "format": "int32"
- },
- "selfLink": {
- "type": "string",
- "description": "[Output only] Server-defined URL for the resource."
- },
- "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"
- }
- },
- "locations": {
- "description": "The list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "instanceGroupUrls": {
- "description": "Deprecated. Use node_pools.instance_group_urls.",
- "type": "array",
- "items": {
- "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"
- },
- "enableKubernetesAlpha": {
- "description": "Kubernetes alpha features are enabled on this cluster. This includes alpha\nAPI groups (e.g. v1beta1) 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"
- },
- "description": {
- "type": "string",
- "description": "An optional description of this cluster."
- },
- "currentNodeCount": {
- "description": "[Output only] The number of nodes currently in the cluster.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Cluster"
- },
- "CreateNodePoolRequest": {
- "description": "CreateNodePoolRequest creates a node pool for a 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 parent instead.",
- "type": "string"
- },
- "zone": {
- "type": "string",
- "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."
- },
- "clusterId": {
- "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
- "type": "string"
- },
- "nodePool": {
- "$ref": "NodePool",
- "description": "The node pool to create."
- },
- "parent": {
- "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.",
- "type": "string"
- }
- },
- "id": "CreateNodePoolRequest"
- },
- "MasterAuth": {
- "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"
- },
- "clientCertificate": {
- "description": "[Output only] Base64-encoded public certificate used by clients to\nauthenticate to the cluster endpoint.",
- "type": "string"
- },
- "username": {
- "description": "The username to use for HTTP basic authentication to the master endpoint.\nFor clusters v1.6.0 and later, you can disable basic authentication by\nproviding an empty username.",
- "type": "string"
- },
- "password": {
- "type": "string",
- "description": "The password to use for HTTP basic authentication to the master endpoint.\nBecause the master endpoint is open to the Internet, you should create a\nstrong password. If a password is provided for cluster creation, username\nmust be non-empty."
- },
- "clientCertificateConfig": {
- "$ref": "ClientCertificateConfig",
- "description": "Configuration for client certificate authentication on the cluster. If no\nconfiguration is specified, a client certificate is issued."
- }
- },
- "id": "MasterAuth"
- },
- "DailyMaintenanceWindow": {
- "properties": {
- "startTime": {
- "description": "Time within the maintenance window to start the maintenance operations.\nIt must be in format \"HH:MM”, where HH : [00-23] and MM : [00-59] GMT.",
- "type": "string"
- },
- "duration": {
- "description": "[Output only] Duration of the time window, automatically chosen to be\nsmallest possible in the given scenario.",
- "type": "string"
- }
- },
- "id": "DailyMaintenanceWindow",
- "description": "Time window specified for daily maintenance operations.",
- "type": "object"
- },
- "ClientCertificateConfig": {
- "description": "Configuration for client certificates on the cluster.",
- "type": "object",
- "properties": {
- "issueClientCertificate": {
- "description": "Issue a client certificate.",
- "type": "boolean"
- }
- },
- "id": "ClientCertificateConfig"
- },
- "MaintenancePolicy": {
- "id": "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"
+ "$ref": "AddonsConfig",
+ "description": "The desired configurations for the various addons available to run in the\ncluster."
}
}
- },
- "SetLoggingServiceRequest": {
- "properties": {
- "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"
- },
- "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"
- }
- },
- "id": "SetLoggingServiceRequest",
- "description": "SetLoggingServiceRequest sets the logging service of a cluster.",
- "type": "object"
- },
- "SetMaintenancePolicyRequest": {
- "description": "SetMaintenancePolicyRequest sets the maintenance policy for a cluster.",
- "type": "object",
- "properties": {
- "clusterId": {
- "description": "The name of the cluster to update.",
- "type": "string"
- },
- "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"
- }
- },
- "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"
}
},
- "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": "Container",
"auth": {
"oauth2": {
@@ -3809,5 +1533,2281 @@
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Container Engine API",
- "ownerName": "Google"
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "locations": {
+ "methods": {
+ "getServerConfig": {
+ "path": "v1beta1/{+name}/serverConfig",
+ "id": "container.projects.locations.getServerConfig",
+ "description": "Returns configuration info about the Container Engine service.",
+ "response": {
+ "$ref": "ServerConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "type": "string",
+ "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."
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverConfig"
+ }
+ },
+ "resources": {
+ "operations": {
+ "methods": {
+ "list": {
+ "description": "Lists all operations in a project in a specific zone or all zones.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "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/[^/]+$"
+ },
+ "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 [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations",
+ "path": "v1beta1/{+parent}/operations",
+ "id": "container.projects.locations.operations.list"
+ },
+ "get": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'."
+ },
+ "operationId": {
+ "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+ "path": "v1beta1/{+name}",
+ "id": "container.projects.locations.operations.get",
+ "description": "Gets the specified operation."
+ },
+ "cancel": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
+ "id": "container.projects.locations.operations.cancel",
+ "path": "v1beta1/{+name}:cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Cancels the specified operation.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "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/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ },
+ "clusters": {
+ "methods": {
+ "create": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
+ "path": "v1beta1/{+parent}/clusters",
+ "id": "container.projects.locations.clusters.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": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "completeIpRotation": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path",
+ "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'."
+ }
+ },
+ "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": {
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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": {
+ "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 to retrieve.\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}",
+ "path": "v1beta1/{+name}",
+ "id": "container.projects.locations.clusters.get",
+ "description": "Gets the details of a specific cluster."
+ },
+ "setNetworkPolicy": {
+ "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 networking policy.\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}:setNetworkPolicy",
+ "path": "v1beta1/{+name}:setNetworkPolicy",
+ "id": "container.projects.locations.clusters.setNetworkPolicy",
+ "description": "Enables/Disables Network Policy for a cluster.",
+ "request": {
+ "$ref": "SetNetworkPolicyRequest"
+ }
+ },
+ "setAddons": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setAddons",
+ "id": "container.projects.locations.clusters.setAddons",
+ "path": "v1beta1/{+name}:setAddons",
+ "request": {
+ "$ref": "SetAddonsConfigRequest"
+ },
+ "description": "Sets the addons of a specific cluster.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "setMonitoring": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMonitoring",
+ "path": "v1beta1/{+name}:setMonitoring",
+ "id": "container.projects.locations.clusters.setMonitoring",
+ "description": "Sets the monitoring service of a specific cluster.",
+ "request": {
+ "$ref": "SetMonitoringServiceRequest"
+ }
+ },
+ "startIpRotation": {
+ "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 start 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}:startIpRotation",
+ "path": "v1beta1/{+name}:startIpRotation",
+ "id": "container.projects.locations.clusters.startIpRotation",
+ "description": "Start master IP rotation.",
+ "request": {
+ "$ref": "StartIPRotationRequest"
+ }
+ },
+ "setMaintenancePolicy": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMaintenancePolicy",
+ "path": "v1beta1/{+name}:setMaintenancePolicy",
+ "id": "container.projects.locations.clusters.setMaintenancePolicy",
+ "description": "Sets the maintenance policy for a cluster.",
+ "request": {
+ "$ref": "SetMaintenancePolicyRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path",
+ "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"
+ }
+ }
+ },
+ "delete": {
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}",
+ "id": "container.projects.locations.clusters.delete",
+ "path": "v1beta1/{+name}",
+ "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.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "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/[^/]+$"
+ },
+ "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": {
+ "location": "query",
+ "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "setResourceLabels": {
+ "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 labels.\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}:setResourceLabels",
+ "path": "v1beta1/{+name}:setResourceLabels",
+ "id": "container.projects.locations.clusters.setResourceLabels",
+ "description": "Sets labels on a cluster.",
+ "request": {
+ "$ref": "SetLabelsRequest"
+ }
+ },
+ "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"
+ },
+ "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"
+ },
+ "setLocations": {
+ "request": {
+ "$ref": "SetLocationsRequest"
+ },
+ "description": "Sets the locations of a specific cluster.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations",
+ "id": "container.projects.locations.clusters.setLocations",
+ "path": "v1beta1/{+name}:setLocations"
+ },
+ "updateMaster": {
+ "description": "Updates the master of a specific cluster.",
+ "request": {
+ "$ref": "UpdateMasterRequest"
+ },
+ "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 update.\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}:updateMaster",
+ "path": "v1beta1/{+name}:updateMaster",
+ "id": "container.projects.locations.clusters.updateMaster"
+ },
+ "update": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+ "location": "path",
+ "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ }
+ },
+ "setLogging": {
+ "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 logging.\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}:setLogging",
+ "path": "v1beta1/{+name}:setLogging",
+ "id": "container.projects.locations.clusters.setLogging",
+ "description": "Sets the logging service of a specific cluster.",
+ "request": {
+ "$ref": "SetLoggingServiceRequest"
+ }
+ },
+ "setMasterAuth": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth",
+ "id": "container.projects.locations.clusters.setMasterAuth",
+ "path": "v1beta1/{+name}: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.\nModify basic_auth.csv and reset the K8S API server.",
+ "request": {
+ "$ref": "SetMasterAuthRequest"
+ }
+ },
+ "list": {
+ "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "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."
+ },
+ "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": {
+ "location": "query",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
+ "id": "container.projects.locations.clusters.list",
+ "path": "v1beta1/{+parent}/clusters"
+ }
+ },
+ "resources": {
+ "nodePools": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "NodePool"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ "location": "path",
+ "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"
+ },
+ "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": {
+ "type": "string",
+ "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."
+ },
+ "clusterId": {
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "nodePoolId": {
+ "type": "string",
+ "location": "query",
+ "description": "The name of the node pool.\nThis field is deprecated, use name instead."
+ }
+ },
+ "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": {
+ "description": "Updates the version and/or iamge type of a specific node pool.",
+ "request": {
+ "$ref": "UpdateNodePoolRequest"
+ },
+ "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, 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/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}",
+ "path": "v1beta1/{+name}",
+ "id": "container.projects.locations.clusters.nodePools.update"
+ },
+ "setAutoscaling": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ "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"
+ }
+ },
+ "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"
+ }
+ },
+ "setManagement": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setManagement",
+ "path": "v1beta1/{+name}:setManagement",
+ "id": "container.projects.locations.clusters.nodePools.setManagement",
+ "request": {
+ "$ref": "SetNodePoolManagementRequest"
+ },
+ "description": "Sets the NodeManagement options for a node pool."
+ },
+ "delete": {
+ "description": "Deletes a node pool from a cluster.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$",
+ "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"
+ },
+ "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": {
+ "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": {
+ "description": "The name of the node pool to delete.\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}/nodePools/{nodePoolsId}",
+ "id": "container.projects.locations.clusters.nodePools.delete",
+ "path": "v1beta1/{+name}"
+ },
+ "list": {
+ "description": "Lists the node pools for a cluster.",
+ "response": {
+ "$ref": "ListNodePoolsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "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": {
+ "description": "The name of the cluster.\nThis field is deprecated, use parent instead.",
+ "type": "string",
+ "location": "query"
+ },
+ "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": {
+ "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 parent instead.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools",
+ "path": "v1beta1/{+parent}/nodePools",
+ "id": "container.projects.locations.clusters.nodePools.list"
+ },
+ "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": {
+ "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",
+ "request": {
+ "$ref": "CreateNodePoolRequest"
+ },
+ "description": "Creates a node pool for a cluster."
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "zones": {
+ "methods": {
+ "getServerconfig": {
+ "description": "Returns configuration info about the Container Engine service.",
+ "response": {
+ "$ref": "ServerConfig"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "query",
+ "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.",
+ "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 [zone](/compute/docs/zones#available)\nto return operations for.\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}/serverconfig",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig",
+ "id": "container.projects.zones.getServerconfig"
+ }
+ },
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel",
+ "id": "container.projects.zones.operations.cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Cancels the specified operation.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "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": {
+ "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",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel"
+ },
+ "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": {
+ "description": "Gets the specified operation.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "operationId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.",
+ "type": "string",
+ "location": "query"
+ },
+ "operationId": {
+ "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "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.",
+ "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"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "clusters": {
+ "resources": {
+ "nodePools": {
+ "methods": {
+ "update": {
+ "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": {
+ "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}/update",
+ "id": "container.projects.zones.clusters.nodePools.update",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update",
+ "request": {
+ "$ref": "UpdateNodePoolRequest"
+ },
+ "description": "Updates the version and/or iamge type of a specific node pool."
+ },
+ "delete": {
+ "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": {
+ "required": true,
+ "type": "string",
+ "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."
+ },
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ ],
+ "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."
+ },
+ "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": {
+ "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": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the node pool to update.\nThis field is deprecated, use name instead."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists the node pools for a cluster.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "ListNodePoolsResponse"
+ },
+ "parameters": {
+ "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": {
+ "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "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 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.list",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools"
+ },
+ "rollback": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId",
+ "nodePoolId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback",
+ "path": "v1beta1/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."
+ },
+ "create": {
+ "path": "v1beta1/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": {
+ "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"
+ },
+ "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": {
+ "description": "The name of the node pool 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}/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": {
+ "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).\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"
+ },
+ "nodePoolId": {
+ "location": "path",
+ "description": "The name of the node pool.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "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/*'.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "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.get",
+ "description": "Retrieves the node pool requested."
+ }
+ }
+ }
+ },
+ "methods": {
+ "master": {
+ "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.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master",
+ "id": "container.projects.zones.clusters.master",
+ "description": "Updates the master of a specific cluster.",
+ "request": {
+ "$ref": "UpdateMasterRequest"
+ }
+ },
+ "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": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "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."
+ },
+ "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}:setMasterAuth",
+ "id": "container.projects.zones.clusters.setMasterAuth",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth"
+ },
+ "logging": {
+ "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": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides."
+ },
+ "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}/logging",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging",
+ "id": "container.projects.zones.clusters.logging",
+ "request": {
+ "$ref": "SetLoggingServiceRequest"
+ },
+ "description": "Sets the logging service of a specific cluster."
+ },
+ "list": {
+ "path": "v1beta1/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.",
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "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\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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters"
+ },
+ "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).\nThis field is deprecated, use parent instead.",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "required": true,
+ "type": "string",
+ "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."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
+ "id": "container.projects.zones.clusters.create"
+ },
+ "resourceLabels": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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": {
+ "required": true,
+ "type": "string",
+ "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."
+ },
+ "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}/resourceLabels",
+ "id": "container.projects.zones.clusters.resourceLabels",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels",
+ "description": "Sets labels on a cluster.",
+ "request": {
+ "$ref": "SetLabelsRequest"
+ }
+ },
+ "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).\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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation",
+ "id": "container.projects.zones.clusters.completeIpRotation"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "parameters": {
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.",
+ "required": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "type": "string",
+ "location": "query"
+ },
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "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."
+ },
+ "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"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.get",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "description": "Gets the details of a specific cluster."
+ },
+ "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": {
+ "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"
+ ],
+ "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": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy",
+ "id": "container.projects.zones.clusters.setNetworkPolicy",
+ "description": "Enables/Disables Network Policy for a cluster.",
+ "request": {
+ "$ref": "SetNetworkPolicyRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST"
+ },
+ "startIpRotation": {
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation",
+ "id": "container.projects.zones.clusters.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).\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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation"
+ },
+ "addons": {
+ "request": {
+ "$ref": "SetAddonsConfigRequest"
+ },
+ "description": "Sets the addons 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).\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 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}/addons",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons",
+ "id": "container.projects.zones.clusters.addons"
+ },
+ "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": {
+ "location": "path",
+ "description": "The name of the cluster to update.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.",
+ "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\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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}",
+ "id": "container.projects.zones.clusters.delete",
+ "path": "v1beta1/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": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "zone",
+ "clusterId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "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."
+ },
+ "zone": {
+ "required": true,
+ "type": "string",
+ "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."
+ },
+ "clusterId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
+ "id": "container.projects.zones.clusters.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": {
+ "clusterId": {
+ "location": "path",
+ "description": "The name of the cluster 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": {
+ "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"
+ }
+ }
+ },
+ "monitoring": {
+ "request": {
+ "$ref": "SetMonitoringServiceRequest"
+ },
+ "description": "Sets the monitoring 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).\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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring",
+ "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring",
+ "id": "container.projects.zones.clusters.monitoring"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "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": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "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."
+ }
+ },
+ "version": "v1beta1",
+ "baseUrl": "https://container.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "The Google Container Engine API is used for building and managing container based applications, powered by the open source Kubernetes technology.",
+ "servicePath": "",
+ "basePath": ""
}
diff --git a/container/v1beta1/container-gen.go b/container/v1beta1/container-gen.go
index de713cc..4304464 100644
--- a/container/v1beta1/container-gen.go
+++ b/container/v1beta1/container-gen.go
@@ -421,7 +421,7 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// Cluster: A Google Kubernetes Engine cluster.
+// Cluster: A Google Container Engine cluster.
type Cluster struct {
// AddonsConfig: Configurations for the various addons available to run
// in the cluster.
@@ -2216,7 +2216,7 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// ServerConfig: Kubernetes Engine service configuration.
+// ServerConfig: Container Engine service configuration.
type ServerConfig struct {
// DefaultClusterVersion: Version of Kubernetes the service deploys by
// default.
@@ -2332,7 +2332,7 @@
// this resource,
// used to detect conflicts. The fingerprint is initially generated
// by
- // Kubernetes Engine and changes after every request to modify or
+ // Container Engine and changes after every request to modify or
// update
// labels. You must always provide an up-to-date fingerprint hash
// when
@@ -3143,7 +3143,7 @@
header_ http.Header
}
-// GetServerConfig: Returns configuration info about the Kubernetes
+// GetServerConfig: Returns configuration info about the Container
// Engine service.
func (r *ProjectsLocationsService) GetServerConfig(name string) *ProjectsLocationsGetServerConfigCall {
c := &ProjectsLocationsGetServerConfigCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -3265,7 +3265,7 @@
}
return ret, nil
// {
- // "description": "Returns configuration info about the Kubernetes Engine service.",
+ // "description": "Returns configuration info about the Container Engine service.",
// "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverConfig",
// "httpMethod": "GET",
// "id": "container.projects.locations.getServerConfig",
@@ -7494,7 +7494,7 @@
header_ http.Header
}
-// GetServerconfig: Returns configuration info about the Kubernetes
+// GetServerconfig: Returns configuration info about the Container
// Engine service.
func (r *ProjectsZonesService) GetServerconfig(projectId string, zone string) *ProjectsZonesGetServerconfigCall {
c := &ProjectsZonesGetServerconfigCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -7606,7 +7606,7 @@
}
return ret, nil
// {
- // "description": "Returns configuration info about the Kubernetes Engine service.",
+ // "description": "Returns configuration info about the Container Engine service.",
// "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig",
// "httpMethod": "GET",
// "id": "container.projects.zones.getServerconfig",
diff --git a/dataflow/v1b3/dataflow-api.json b/dataflow/v1b3/dataflow-api.json
index 1eb68a9..65ea852 100644
--- a/dataflow/v1b3/dataflow-api.json
+++ b/dataflow/v1b3/dataflow-api.json
@@ -1,4 +1,9 @@
{
+ "rootUrl": "https://dataflow.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "dataflow",
+ "batchPath": "batch",
"revision": "20171209",
"documentationLink": "https://cloud.google.com/dataflow",
"id": "dataflow:v1b3",
@@ -7,75 +12,33 @@
"ownerName": "Google",
"resources": {
"projects": {
- "methods": {
- "workerMessages": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "SendWorkerMessagesResponse"
- },
- "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": "The project to send the WorkerMessages to.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/WorkerMessages",
- "id": "dataflow.projects.workerMessages",
- "path": "v1b3/projects/{projectId}/WorkerMessages",
- "description": "Send a worker_message to the service.",
- "request": {
- "$ref": "SendWorkerMessagesRequest"
- }
- }
- },
"resources": {
"templates": {
"methods": {
"launch": {
- "description": "Launch a template.",
- "request": {
- "$ref": "LaunchTemplateParameters"
- },
- "response": {
- "$ref": "LaunchTemplateResponse"
- },
+ "httpMethod": "POST",
"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"
- ],
+ "response": {
+ "$ref": "LaunchTemplateResponse"
+ },
"parameters": {
"validateOnly": {
+ "location": "query",
"description": "If true, the request is validated but not actually executed.\nDefaults to false.",
- "type": "boolean",
- "location": "query"
+ "type": "boolean"
},
"projectId": {
+ "location": "path",
"description": "Required. The ID of the Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"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"
+ "type": "string",
+ "location": "query"
},
"location": {
"location": "query",
@@ -83,9 +46,19 @@
"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}/templates:launch",
+ "id": "dataflow.projects.templates.launch",
"path": "v1b3/projects/{projectId}/templates:launch",
- "id": "dataflow.projects.templates.launch"
+ "request": {
+ "$ref": "LaunchTemplateParameters"
+ },
+ "description": "Launch a template."
},
"get": {
"path": "v1b3/projects/{projectId}/templates:get",
@@ -98,20 +71,26 @@
"projectId"
],
"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": {
- "location": "path",
"description": "Required. The ID of the Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"view": {
- "location": "query",
"enum": [
"METADATA_ONLY"
],
"description": "The view to retrieve. Defaults to METADATA_ONLY.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"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://`.",
@@ -124,12 +103,6 @@
"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}/templates:get"
},
"create": {
@@ -142,10 +115,10 @@
"httpMethod": "POST",
"parameters": {
"projectId": {
- "location": "path",
"description": "Required. The ID of the Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -165,85 +138,9 @@
}
},
"locations": {
- "methods": {
- "workerMessages": {
- "description": "Send a worker_message to the service.",
- "request": {
- "$ref": "SendWorkerMessagesRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "location"
- ],
- "response": {
- "$ref": "SendWorkerMessagesResponse"
- },
- "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": "path",
- "description": "The location which contains the job",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "The project to send the WorkerMessages to.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages",
- "id": "dataflow.projects.locations.workerMessages",
- "path": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages"
- }
- },
"resources": {
"templates": {
"methods": {
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "location"
- ],
- "response": {
- "$ref": "Job"
- },
- "parameters": {
- "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"
- }
- },
- "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}/templates",
- "id": "dataflow.projects.locations.templates.create",
- "path": "v1b3/projects/{projectId}/locations/{location}/templates",
- "request": {
- "$ref": "CreateJobFromTemplateRequest"
- },
- "description": "Creates a Cloud Dataflow job from a template."
- },
"launch": {
"response": {
"$ref": "LaunchTemplateResponse"
@@ -266,15 +163,15 @@
"type": "string"
},
"location": {
+ "location": "path",
"description": "The location to which to direct the request.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"validateOnly": {
- "location": "query",
"description": "If true, the request is validated but not actually executed.\nDefaults to false.",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
},
"projectId": {
"description": "Required. The ID of the Cloud Platform project that the job belongs to.",
@@ -292,7 +189,7 @@
}
},
"get": {
- "httpMethod": "GET",
+ "description": "Get the template associated with a template.",
"response": {
"$ref": "GetTemplateResponse"
},
@@ -300,18 +197,14 @@
"projectId",
"location"
],
+ "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": {
- "location": "path",
- "description": "The location to which to direct the request.",
- "required": true,
- "type": "string"
- },
"projectId": {
"location": "path",
"description": "Required. The ID of the Cloud Platform project that the job belongs to.",
@@ -319,300 +212,71 @@
"type": "string"
},
"view": {
- "location": "query",
"enum": [
"METADATA_ONLY"
],
"description": "The view to retrieve. Defaults to METADATA_ONLY.",
+ "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"
+ },
+ "location": {
+ "description": "The location to which to direct the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:get",
+ "path": "v1b3/projects/{projectId}/locations/{location}/templates:get",
+ "id": "dataflow.projects.locations.templates.get"
+ },
+ "create": {
+ "description": "Creates a Cloud Dataflow job from a template.",
+ "request": {
+ "$ref": "CreateJobFromTemplateRequest"
+ },
+ "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"
],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:get",
- "id": "dataflow.projects.locations.templates.get",
- "path": "v1b3/projects/{projectId}/locations/{location}/templates:get",
- "description": "Get the template associated with a template."
+ "parameters": {
+ "projectId": {
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "location": {
+ "description": "The location to which to direct the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates",
+ "path": "v1b3/projects/{projectId}/locations/{location}/templates",
+ "id": "dataflow.projects.locations.templates.create"
}
}
},
"jobs": {
- "resources": {
- "debug": {
- "methods": {
- "getConfig": {
- "request": {
- "$ref": "GetDebugConfigRequest"
- },
- "description": "Get encoded debug configuration for component. Not cacheable.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "response": {
- "$ref": "GetDebugConfigResponse"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project id.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "description": "The job id.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "location": {
- "location": "path",
- "description": "The location which contains the job specified by 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"
- ],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig",
- "id": "dataflow.projects.locations.jobs.debug.getConfig",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig"
- },
- "sendCapture": {
- "response": {
- "$ref": "SendDebugCaptureResponse"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project id.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "location": "path",
- "description": "The job id.",
- "required": true,
- "type": "string"
- },
- "location": {
- "location": "path",
- "description": "The location which contains the job specified by 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"
- ],
- "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",
- "request": {
- "$ref": "SendDebugCaptureRequest"
- },
- "description": "Send encoded debug capture data for component."
- }
- }
- },
- "workItems": {
- "methods": {
- "lease": {
- "response": {
- "$ref": "LeaseWorkItemResponse"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "description": "Identifies the project this worker belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "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}/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."
- },
- "reportStatus": {
- "response": {
- "$ref": "ReportWorkItemStatusResponse"
- },
- "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": {
- "description": "The project which owns the WorkItem's job.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "jobId": {
- "location": "path",
- "description": "The job which the WorkItem is part of.",
- "required": true,
- "type": "string"
- },
- "location": {
- "description": "The location which contains the WorkItem's job.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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",
- "description": "Reports the status of dataflow WorkItems leased by a worker.",
- "request": {
- "$ref": "ReportWorkItemStatusRequest"
- }
- }
- }
- },
- "messages": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListJobMessagesResponse"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "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"
- },
- "pageSize": {
- "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",
- "location": "query"
- },
- "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"
- },
- "jobId": {
- "description": "The job to get messages about.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "A project 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"
- }
- },
- "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",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
- "id": "dataflow.projects.locations.jobs.messages.list",
- "description": "Request the job status."
- }
- }
- }
- },
"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"
},
@@ -622,18 +286,18 @@
"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": {
+ "location": {
+ "location": "path",
+ "description": "The location which contains the job specified by job_id.",
+ "required": true,
+ "type": "string"
+ },
"startTime": {
- "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",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"projectId": {
"description": "A project id.",
@@ -646,17 +310,24 @@
"required": true,
"type": "string",
"location": "path"
- },
- "location": {
- "description": "The location which contains the job specified by job_id.",
- "required": true,
- "type": "string",
- "location": "path"
}
},
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics"
+ "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}/metrics",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
+ "id": "dataflow.projects.locations.jobs.getMetrics",
+ "description": "Request the job status."
},
"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"
},
@@ -665,13 +336,6 @@
"location",
"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": {
"location": {
"location": "path",
@@ -703,12 +367,19 @@
"location": "query"
}
},
- "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."
+ "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}"
},
"list": {
+ "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"
},
@@ -716,16 +387,14 @@
"projectId",
"location"
],
- "httpMethod": "GET",
"parameters": {
"projectId": {
- "location": "path",
"description": "The project which owns the jobs.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"filter": {
- "location": "query",
"enum": [
"UNKNOWN",
"ALL",
@@ -733,7 +402,8 @@
"ACTIVE"
],
"description": "The kind of filter to use.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"location": {
"description": "The location that contains this job.",
@@ -742,15 +412,15 @@
"location": "path"
},
"pageToken": {
+ "location": "query",
"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"
+ "type": "string"
},
"pageSize": {
+ "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",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"view": {
"enum": [
@@ -770,39 +440,36 @@
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "id": "dataflow.projects.locations.jobs.list",
- "description": "List the jobs of a project in a given region."
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs"
},
"update": {
- "id": "dataflow.projects.locations.jobs.update",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
- "request": {
+ "response": {
"$ref": "Job"
},
- "description": "Updates the state of an existing Cloud Dataflow job.",
- "httpMethod": "PUT",
"parameterOrder": [
"projectId",
"location",
"jobId"
],
- "response": {
- "$ref": "Job"
- },
+ "httpMethod": "PUT",
+ "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": "path",
"description": "The location that contains this job.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"projectId": {
- "location": "path",
"description": "The ID of the Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"jobId": {
"location": "path",
@@ -811,13 +478,13 @@
"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}"
+ "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": {
"description": "Creates a Cloud Dataflow job.",
@@ -851,13 +518,12 @@
"location": "query"
},
"projectId": {
+ "location": "path",
"description": "The ID of the Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"view": {
- "location": "query",
"enum": [
"JOB_VIEW_UNKNOWN",
"JOB_VIEW_SUMMARY",
@@ -865,29 +531,388 @@
"JOB_VIEW_DESCRIPTION"
],
"description": "The level of information requested in response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs",
"path": "v1b3/projects/{projectId}/locations/{location}/jobs",
"id": "dataflow.projects.locations.jobs.create"
}
+ },
+ "resources": {
+ "debug": {
+ "methods": {
+ "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"
+ },
+ "response": {
+ "$ref": "GetDebugConfigResponse"
+ },
+ "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": {
+ "location": {
+ "description": "The location which contains the job specified by job_id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "description": "The job id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig"
+ },
+ "sendCapture": {
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture",
+ "id": "dataflow.projects.locations.jobs.debug.sendCapture",
+ "request": {
+ "$ref": "SendDebugCaptureRequest"
+ },
+ "description": "Send encoded debug capture data for component.",
+ "response": {
+ "$ref": "SendDebugCaptureResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "location": {
+ "location": "path",
+ "description": "The location which contains the job specified by job_id.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "description": "The job id.",
+ "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"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture"
+ }
+ }
+ },
+ "workItems": {
+ "methods": {
+ "reportStatus": {
+ "response": {
+ "$ref": "ReportWorkItemStatusResponse"
+ },
+ "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": "The project which owns the WorkItem's job.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job which the WorkItem is part of.",
+ "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:reportStatus",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus",
+ "id": "dataflow.projects.locations.jobs.workItems.reportStatus",
+ "description": "Reports the status of dataflow WorkItems leased by a worker.",
+ "request": {
+ "$ref": "ReportWorkItemStatusRequest"
+ }
+ },
+ "lease": {
+ "response": {
+ "$ref": "LeaseWorkItemResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "description": "Identifies the project this worker belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "description": "Identifies the workflow job this worker belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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}/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."
+ }
+ }
+ },
+ "messages": {
+ "methods": {
+ "list": {
+ "description": "Request the job status.",
+ "response": {
+ "$ref": "ListJobMessagesResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "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": {
+ "endTime": {
+ "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": "query"
+ },
+ "location": {
+ "location": "path",
+ "description": "The location which contains the job specified by job_id.",
+ "required": true,
+ "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"
+ },
+ "startTime": {
+ "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"
+ },
+ "pageSize": {
+ "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",
+ "location": "query"
+ },
+ "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"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "A project id.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "description": "The job to get messages about.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
+ "id": "dataflow.projects.locations.jobs.messages.list"
+ }
+ }
+ }
}
}
+ },
+ "methods": {
+ "workerMessages": {
+ "response": {
+ "$ref": "SendWorkerMessagesResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "location": {
+ "description": "The location which contains the job",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "The project to send the WorkerMessages to.",
+ "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"
+ ],
+ "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."
+ }
}
},
"jobs": {
"methods": {
+ "update": {
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "location": {
+ "description": "The location that contains this job.",
+ "type": "string",
+ "location": "query"
+ },
+ "projectId": {
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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"
+ ],
+ "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."
+ },
"aggregated": {
+ "id": "dataflow.projects.jobs.aggregated",
+ "path": "v1b3/projects/{projectId}/jobs:aggregated",
+ "description": "List the jobs of a project across all regions.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListJobsResponse"
},
"parameterOrder": [
"projectId"
],
- "httpMethod": "GET",
"parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The project which owns the jobs.",
+ "required": true,
+ "type": "string"
+ },
"filter": {
+ "location": "query",
"enum": [
"UNKNOWN",
"ALL",
@@ -895,8 +920,7 @@
"ACTIVE"
],
"description": "The kind of filter to use.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"location": {
"description": "The location that contains this job.",
@@ -909,13 +933,12 @@
"location": "query"
},
"pageSize": {
+ "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",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"view": {
- "location": "query",
"enum": [
"JOB_VIEW_UNKNOWN",
"JOB_VIEW_SUMMARY",
@@ -923,13 +946,8 @@
"JOB_VIEW_DESCRIPTION"
],
"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"
+ "location": "query"
}
},
"scopes": [
@@ -938,10 +956,7 @@
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
],
- "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."
+ "flatPath": "v1b3/projects/{projectId}/jobs:aggregated"
},
"list": {
"response": {
@@ -951,8 +966,15 @@
"projectId"
],
"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": {
"filter": {
+ "location": "query",
"enum": [
"UNKNOWN",
"ALL",
@@ -960,13 +982,12 @@
"ACTIVE"
],
"description": "The kind of filter to use.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"location": {
- "location": "query",
"description": "The location that contains this job.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageToken": {
"location": "query",
@@ -997,34 +1018,30 @@
"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}/jobs",
"path": "v1b3/projects/{projectId}/jobs",
"id": "dataflow.projects.jobs.list",
"description": "List the jobs of a project in a given region."
},
"create": {
+ "id": "dataflow.projects.jobs.create",
+ "path": "v1b3/projects/{projectId}/jobs",
"request": {
"$ref": "Job"
},
"description": "Creates a Cloud Dataflow job.",
- "response": {
- "$ref": "Job"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"projectId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Job"
+ },
"parameters": {
"replaceJobId": {
+ "location": "query",
"description": "Deprecated. This field is now in the Job message.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"projectId": {
"location": "path",
@@ -1044,9 +1061,9 @@
"type": "string"
},
"location": {
- "location": "query",
"description": "The location that contains this job.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
@@ -1055,14 +1072,9 @@
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
],
- "flatPath": "v1b3/projects/{projectId}/jobs",
- "path": "v1b3/projects/{projectId}/jobs",
- "id": "dataflow.projects.jobs.create"
+ "flatPath": "v1b3/projects/{projectId}/jobs"
},
"getMetrics": {
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
- "id": "dataflow.projects.jobs.getMetrics",
- "description": "Request the job status.",
"response": {
"$ref": "JobMetrics"
},
@@ -1084,10 +1096,10 @@
"type": "string"
},
"projectId": {
- "location": "path",
"description": "A project id.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"jobId": {
"description": "The job to get messages for.",
@@ -1102,23 +1114,26 @@
"https://www.googleapis.com/auth/compute.readonly",
"https://www.googleapis.com/auth/userinfo.email"
],
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/metrics"
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
+ "id": "dataflow.projects.jobs.getMetrics",
+ "description": "Request the job status."
},
"get": {
"description": "Gets the state of the specified Cloud Dataflow job.",
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Job"
+ },
"parameterOrder": [
"projectId",
"jobId"
],
- "response": {
- "$ref": "Job"
- },
+ "httpMethod": "GET",
"parameters": {
"location": {
- "location": "query",
"description": "The location that contains this job.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"projectId": {
"location": "path",
@@ -1133,6 +1148,7 @@
"location": "path"
},
"view": {
+ "location": "query",
"enum": [
"JOB_VIEW_UNKNOWN",
"JOB_VIEW_SUMMARY",
@@ -1140,61 +1156,18 @@
"JOB_VIEW_DESCRIPTION"
],
"description": "The level of information requested in response.",
- "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}",
- "id": "dataflow.projects.jobs.get",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}"
- },
- "update": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "httpMethod": "PUT",
- "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": {
- "description": "The location that contains this job.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "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"
+ ],
"flatPath": "v1b3/projects/{projectId}/jobs/{jobId}",
"path": "v1b3/projects/{projectId}/jobs/{jobId}",
- "id": "dataflow.projects.jobs.update",
- "description": "Updates the state of an existing Cloud Dataflow job.",
- "request": {
- "$ref": "Job"
- }
+ "id": "dataflow.projects.jobs.get"
}
},
"resources": {
@@ -1209,43 +1182,49 @@
"jobId"
],
"httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project id.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "description": "The job id.",
- "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": {
+ "description": "The project id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job id.",
+ "required": true,
+ "type": "string"
+ }
+ },
"flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
"path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
"id": "dataflow.projects.jobs.debug.getConfig",
+ "description": "Get encoded debug configuration for component. Not cacheable.",
"request": {
"$ref": "GetDebugConfigRequest"
- },
- "description": "Get encoded debug configuration for component. Not cacheable."
+ }
},
"sendCapture": {
- "httpMethod": "POST",
+ "response": {
+ "$ref": "SendDebugCaptureResponse"
+ },
"parameterOrder": [
"projectId",
"jobId"
],
- "response": {
- "$ref": "SendDebugCaptureResponse"
- },
+ "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",
@@ -1260,24 +1239,55 @@
"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"
- ],
"flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
- "id": "dataflow.projects.jobs.debug.sendCapture",
"path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
+ "id": "dataflow.projects.jobs.debug.sendCapture",
+ "description": "Send encoded debug capture data for component.",
"request": {
"$ref": "SendDebugCaptureRequest"
- },
- "description": "Send encoded debug capture data for component."
+ }
}
}
},
"workItems": {
"methods": {
+ "reportStatus": {
+ "response": {
+ "$ref": "ReportWorkItemStatusResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "description": "The project which owns the WorkItem's job.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job which the WorkItem is part of.",
+ "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}/jobs/{jobId}/workItems:reportStatus",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
+ "id": "dataflow.projects.jobs.workItems.reportStatus",
+ "request": {
+ "$ref": "ReportWorkItemStatusRequest"
+ },
+ "description": "Reports the status of dataflow WorkItems leased by a worker."
+ },
"lease": {
"response": {
"$ref": "LeaseWorkItemResponse"
@@ -1289,16 +1299,16 @@
"httpMethod": "POST",
"parameters": {
"projectId": {
- "location": "path",
"description": "Identifies the project this worker belongs to.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"jobId": {
- "location": "path",
"description": "Identifies the workflow job this worker belongs to.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -1314,43 +1324,6 @@
"$ref": "LeaseWorkItemRequest"
},
"description": "Leases a dataflow WorkItem to run."
- },
- "reportStatus": {
- "description": "Reports the status of dataflow WorkItems leased by a worker.",
- "request": {
- "$ref": "ReportWorkItemStatusRequest"
- },
- "response": {
- "$ref": "ReportWorkItemStatusResponse"
- },
- "parameterOrder": [
- "projectId",
- "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": "The project which owns the WorkItem's job.",
- "required": true,
- "type": "string"
- },
- "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"
}
}
},
@@ -1367,35 +1340,48 @@
"jobId"
],
"parameters": {
+ "jobId": {
+ "description": "The job to get messages about.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "A project id.",
+ "required": true,
+ "type": "string"
+ },
"location": {
"description": "The location which contains the job specified by job_id.",
"type": "string",
"location": "query"
},
"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": {
- "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"
},
"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"
+ "type": "string"
+ },
+ "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": {
+ "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",
- "location": "query"
+ "type": "integer"
},
"minimumImportance": {
+ "location": "query",
"enum": [
"JOB_MESSAGE_IMPORTANCE_UNKNOWN",
"JOB_MESSAGE_DEBUG",
@@ -1405,20 +1391,7 @@
"JOB_MESSAGE_ERROR"
],
"description": "Filter to only get messages with importance \u003e= level",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "description": "A project id.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "jobId": {
- "description": "The job to get messages about.",
- "required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -1435,6 +1408,38 @@
}
}
}
+ },
+ "methods": {
+ "workerMessages": {
+ "response": {
+ "$ref": "SendWorkerMessagesResponse"
+ },
+ "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": {
+ "projectId": {
+ "description": "The project to send the WorkerMessages to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/WorkerMessages",
+ "path": "v1b3/projects/{projectId}/WorkerMessages",
+ "id": "dataflow.projects.workerMessages",
+ "description": "Send a worker_message to the service.",
+ "request": {
+ "$ref": "SendWorkerMessagesRequest"
+ }
+ }
}
}
},
@@ -1450,27 +1455,14 @@
"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"
},
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
+ "fields": {
"location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"callback": {
@@ -1478,6 +1470,19 @@
"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",
@@ -1494,15 +1499,15 @@
"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"
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
},
"quotaUser": {
"location": "query",
@@ -1515,85 +1520,28 @@
"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"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
}
},
"schemas": {
- "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.",
- "type": "object",
- "properties": {
- "sideInputs": {
- "description": "Zero or more side inputs.",
- "type": "array",
- "items": {
- "$ref": "SideInputInfo"
- }
- },
- "multiOutputInfos": {
- "description": "Information about each of the outputs, if user_fn is a MultiDoFn.",
- "type": "array",
- "items": {
- "$ref": "MultiOutputInfo"
- }
- },
- "userFn": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The user function to invoke.",
- "type": "object"
- },
- "input": {
- "description": "The input.",
- "$ref": "InstructionInput"
- },
- "numOutputs": {
- "description": "The number of outputs.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ParDoInstruction"
- },
"MetricUpdate": {
- "description": "Describes the state of a metric.",
- "type": "object",
"properties": {
- "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",
- "type": "string"
- },
- "name": {
- "description": "Name of the metric.",
- "$ref": "MetricStructuredName"
- },
- "distribution": {
- "description": "A struct value describing properties of a distribution of numeric values.",
- "type": "any"
- },
- "set": {
- "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"
},
- "internal": {
- "description": "Worker-computed aggregate value for internal use by the Dataflow\nservice.",
- "type": "any"
- },
"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"
@@ -1609,9 +1557,28 @@
"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"
+ },
+ "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",
+ "type": "string"
+ },
+ "name": {
+ "$ref": "MetricStructuredName",
+ "description": "Name of the metric."
+ },
+ "distribution": {
+ "description": "A struct value describing properties of a distribution of numeric values.",
+ "type": "any"
+ },
+ "set": {
+ "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.",
+ "type": "any"
}
},
- "id": "MetricUpdate"
+ "id": "MetricUpdate",
+ "description": "Describes the state of a metric.",
+ "type": "object"
},
"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.",
@@ -1651,18 +1618,18 @@
"type": "string"
},
"portion": {
- "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.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Counter portion has not been set.",
+ "Counter reports a key.",
+ "Counter reports a value."
+ ]
},
"originalStepName": {
"description": "System generated name of the original step in the user's graph, before\noptimization.",
@@ -1691,7 +1658,14 @@
"id": "WorkerShutdownNotice"
},
"ApproximateProgress": {
+ "description": "Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.",
+ "type": "object",
"properties": {
+ "percentComplete": {
+ "description": "Obsolete.",
+ "format": "float",
+ "type": "number"
+ },
"remainingTime": {
"description": "Obsolete.",
"format": "google-duration",
@@ -1700,16 +1674,9 @@
"position": {
"$ref": "Position",
"description": "Obsolete."
- },
- "percentComplete": {
- "description": "Obsolete.",
- "format": "float",
- "type": "number"
}
},
- "id": "ApproximateProgress",
- "description": "Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.",
- "type": "object"
+ "id": "ApproximateProgress"
},
"WorkerMessageResponse": {
"description": "A worker_message response allows the server to pass information to the\nsender.",
@@ -1720,19 +1687,17 @@
"description": "Service's response to reporting worker metrics (currently empty)."
},
"workerShutdownNoticeResponse": {
- "description": "Service's response to shutdown notice (currently empty).",
- "$ref": "WorkerShutdownNoticeResponse"
+ "$ref": "WorkerShutdownNoticeResponse",
+ "description": "Service's response to shutdown notice (currently empty)."
},
"workerHealthReportResponse": {
- "$ref": "WorkerHealthReportResponse",
- "description": "The service's response to a worker's health report."
+ "description": "The service's response to a worker's health report.",
+ "$ref": "WorkerHealthReportResponse"
}
},
"id": "WorkerMessageResponse"
},
"TemplateMetadata": {
- "description": "Metadata describing a template.",
- "type": "object",
"properties": {
"name": {
"description": "Required. The name of the template.",
@@ -1750,20 +1715,28 @@
"type": "string"
}
},
- "id": "TemplateMetadata"
+ "id": "TemplateMetadata",
+ "description": "Metadata describing a template.",
+ "type": "object"
},
"WorkerMessage": {
- "description": "WorkerMessage provides information to the backend about a worker.",
- "type": "object",
"properties": {
- "workerMetrics": {
- "description": "Resource metrics reported by workers.",
- "$ref": "ResourceUtilizationReport"
+ "workerShutdownNotice": {
+ "$ref": "WorkerShutdownNotice",
+ "description": "Shutdown notice by workers."
+ },
+ "workerHealthReport": {
+ "$ref": "WorkerHealthReport",
+ "description": "The health of a worker."
},
"workerMessageCode": {
"description": "A worker message code.",
"$ref": "WorkerMessageCode"
},
+ "workerMetrics": {
+ "$ref": "ResourceUtilizationReport",
+ "description": "Resource metrics reported by workers."
+ },
"labels": {
"additionalProperties": {
"type": "string"
@@ -1775,19 +1748,15 @@
"description": "The timestamp of the worker_message.",
"format": "google-datetime",
"type": "string"
- },
- "workerShutdownNotice": {
- "$ref": "WorkerShutdownNotice",
- "description": "Shutdown notice by workers."
- },
- "workerHealthReport": {
- "description": "The health of a worker.",
- "$ref": "WorkerHealthReport"
}
},
- "id": "WorkerMessage"
+ "id": "WorkerMessage",
+ "description": "WorkerMessage provides information to the backend about a worker.",
+ "type": "object"
},
"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",
"properties": {
"metricTime": {
"description": "Timestamp as of which metric values are current.",
@@ -1802,15 +1771,13 @@
}
}
},
- "id": "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"
+ "id": "JobMetrics"
},
"WorkerShutdownNoticeResponse": {
- "description": "Service-side response to WorkerMessage issuing shutdown notice.",
- "type": "object",
"properties": {},
- "id": "WorkerShutdownNoticeResponse"
+ "id": "WorkerShutdownNoticeResponse",
+ "description": "Service-side response to WorkerMessage issuing shutdown notice.",
+ "type": "object"
},
"FloatingPointList": {
"properties": {
@@ -1831,34 +1798,9 @@
"description": "An update to a Counter sent from a worker.",
"type": "object",
"properties": {
- "nameAndKind": {
- "description": "Counter name and aggregation type.",
- "$ref": "NameAndKind"
- },
- "stringList": {
- "description": "List of strings, for Set.",
- "$ref": "StringList"
- },
- "distribution": {
- "$ref": "DistributionUpdate",
- "description": "Distribution data"
- },
- "shortId": {
- "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",
- "type": "string"
- },
- "floatingPointList": {
- "$ref": "FloatingPointList",
- "description": "List of floating point numbers, for Set."
- },
- "integer": {
- "description": "Integer value for Sum, Max, Min.",
- "$ref": "SplitInt64"
- },
"integerList": {
- "description": "List of integers, for Set.",
- "$ref": "IntegerList"
+ "$ref": "IntegerList",
+ "description": "List of integers, for Set."
},
"structuredNameAndMetadata": {
"$ref": "CounterStructuredNameAndMetadata",
@@ -1888,6 +1830,31 @@
"boolean": {
"description": "Boolean value for And, Or.",
"type": "boolean"
+ },
+ "nameAndKind": {
+ "$ref": "NameAndKind",
+ "description": "Counter name and aggregation type."
+ },
+ "stringList": {
+ "description": "List of strings, for Set.",
+ "$ref": "StringList"
+ },
+ "distribution": {
+ "$ref": "DistributionUpdate",
+ "description": "Distribution data"
+ },
+ "shortId": {
+ "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",
+ "type": "string"
+ },
+ "floatingPointList": {
+ "description": "List of floating point numbers, for Set.",
+ "$ref": "FloatingPointList"
+ },
+ "integer": {
+ "description": "Integer value for Sum, Max, Min.",
+ "$ref": "SplitInt64"
}
},
"id": "CounterUpdate"
@@ -1914,9 +1881,17 @@
},
"DistributionUpdate": {
"properties": {
- "count": {
+ "histogram": {
+ "$ref": "Histogram",
+ "description": "(Optional) Histogram of value counts for the distribution."
+ },
+ "max": {
"$ref": "SplitInt64",
- "description": "The count of the number of elements present in the distribution."
+ "description": "The maximum value present in the distribution."
+ },
+ "count": {
+ "description": "The count of the number of elements present in the distribution.",
+ "$ref": "SplitInt64"
},
"min": {
"description": "The minimum value present in the distribution.",
@@ -1930,43 +1905,12 @@
"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."
- },
- "histogram": {
- "description": "(Optional) Histogram of value counts for the distribution.",
- "$ref": "Histogram"
- },
- "max": {
- "description": "The maximum value present in the distribution.",
- "$ref": "SplitInt64"
}
},
"id": "DistributionUpdate",
"description": "A metric value representing a distribution.",
"type": "object"
},
- "SourceFork": {
- "properties": {
- "primary": {
- "description": "DEPRECATED",
- "$ref": "SourceSplitShard"
- },
- "primarySource": {
- "$ref": "DerivedSource",
- "description": "DEPRECATED"
- },
- "residual": {
- "$ref": "SourceSplitShard",
- "description": "DEPRECATED"
- },
- "residualSource": {
- "$ref": "DerivedSource",
- "description": "DEPRECATED"
- }
- },
- "id": "SourceFork",
- "description": "DEPRECATED in favor of DynamicSourceSplit.",
- "type": "object"
- },
"WorkerHealthReportResponse": {
"description": "WorkerHealthReportResponse contains information returned to the worker\nin response to a health ping.",
"type": "object",
@@ -1979,30 +1923,36 @@
},
"id": "WorkerHealthReportResponse"
},
+ "SourceFork": {
+ "description": "DEPRECATED in favor of DynamicSourceSplit.",
+ "type": "object",
+ "properties": {
+ "residual": {
+ "$ref": "SourceSplitShard",
+ "description": "DEPRECATED"
+ },
+ "residualSource": {
+ "description": "DEPRECATED",
+ "$ref": "DerivedSource"
+ },
+ "primary": {
+ "description": "DEPRECATED",
+ "$ref": "SourceSplitShard"
+ },
+ "primarySource": {
+ "description": "DEPRECATED",
+ "$ref": "DerivedSource"
+ }
+ },
+ "id": "SourceFork"
+ },
"WorkItemStatus": {
"description": "Conveys a worker's progress through the work described by a WorkItem.",
"type": "object",
"properties": {
- "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": {
- "description": "The worker's progress through this WorkItem.",
- "$ref": "ApproximateReportedProgress"
- },
"sourceFork": {
- "$ref": "SourceFork",
- "description": "DEPRECATED in favor of dynamic_source_split."
+ "description": "DEPRECATED in favor of dynamic_source_split.",
+ "$ref": "SourceFork"
},
"totalThrottlerWaitTimeSeconds": {
"description": "Total time the worker spent being throttled by external systems.",
@@ -2020,13 +1970,6 @@
"description": "Identifies the WorkItem.",
"type": "string"
},
- "metricUpdates": {
- "description": "DEPRECATED in favor of counter_updates.",
- "type": "array",
- "items": {
- "$ref": "MetricUpdate"
- }
- },
"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",
@@ -2034,29 +1977,51 @@
"$ref": "Status"
}
},
+ "metricUpdates": {
+ "description": "DEPRECATED in favor of counter_updates.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricUpdate"
+ }
+ },
"dynamicSourceSplit": {
- "description": "See documentation of stop_position.",
- "$ref": "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."
+ "description": "If the work item represented a SourceOperationRequest, and the work\nis completed, contains the result of the operation.",
+ "$ref": "SourceOperationResponse"
},
"progress": {
- "description": "DEPRECATED in favor of reported_progress.",
- "$ref": "ApproximateProgress"
+ "$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": {
+ "description": "The worker's progress through this WorkItem.",
+ "$ref": "ApproximateReportedProgress"
}
},
"id": "WorkItemStatus"
},
"ComponentSource": {
- "description": "Description of an interstitial value between transforms in an execution\nstage.",
- "type": "object",
"properties": {
"name": {
"description": "Dataflow service generated name for this source.",
@@ -2071,9 +2036,13 @@
"type": "string"
}
},
- "id": "ComponentSource"
+ "id": "ComponentSource",
+ "description": "Description of an interstitial value between transforms in an execution\nstage.",
+ "type": "object"
},
"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": {
"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).",
@@ -2089,35 +2058,12 @@
"type": "integer"
}
},
- "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.",
- "type": "object"
+ "id": "Histogram"
},
"WorkItemServiceState": {
"description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker.",
"type": "object",
"properties": {
- "splitRequest": {
- "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task.",
- "$ref": "ApproximateSplitRequest"
- },
- "reportStatusInterval": {
- "description": "New recommended reporting interval.",
- "format": "google-duration",
- "type": "string"
- },
- "suggestedStopPosition": {
- "description": "Obsolete, always empty.",
- "$ref": "Position"
- },
- "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",
@@ -2136,15 +2082,34 @@
"type": "string"
},
"suggestedStopPoint": {
- "$ref": "ApproximateProgress",
- "description": "DEPRECATED in favor of split_request."
+ "description": "DEPRECATED in favor of split_request.",
+ "$ref": "ApproximateProgress"
+ },
+ "splitRequest": {
+ "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task.",
+ "$ref": "ApproximateSplitRequest"
+ },
+ "suggestedStopPosition": {
+ "description": "Obsolete, always empty.",
+ "$ref": "Position"
+ },
+ "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": {
"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.",
@@ -2162,24 +2127,28 @@
"type": "object"
}
},
- "id": "MetricStructuredName"
+ "id": "MetricStructuredName",
+ "description": "Identifies a metric, by describing the source which generated the\nmetric.",
+ "type": "object"
},
"SeqMapTaskOutputInfo": {
- "description": "Information about an output of a SeqMapTask.",
- "type": "object",
"properties": {
- "sink": {
- "description": "The sink to write the output value to.",
- "$ref": "Sink"
- },
"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"
+ "id": "SeqMapTaskOutputInfo",
+ "description": "Information about an output of a SeqMapTask.",
+ "type": "object"
},
"JobExecutionStageInfo": {
+ "description": "Contains information about how a particular\ngoogle.dataflow.v1beta3.Step will be executed.",
+ "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.",
@@ -2189,22 +2158,10 @@
}
}
},
- "id": "JobExecutionStageInfo",
- "description": "Contains information about how a particular\ngoogle.dataflow.v1beta3.Step will be executed.",
- "type": "object"
+ "id": "JobExecutionStageInfo"
},
"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": {
- "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"
@@ -2216,9 +2173,19 @@
"end": {
"description": "The end (exclusive) of the key range.",
"type": "string"
+ },
+ "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"
}
},
- "id": "KeyRangeLocation"
+ "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": {
@@ -2231,15 +2198,47 @@
"description": "A request to compute the SourceMetadata of a Source.",
"type": "object"
},
- "SeqMapTask": {
+ "NameAndKind": {
+ "description": "Basic metadata about a counter.",
+ "type": "object",
"properties": {
- "inputs": {
- "description": "Information about each of the inputs.",
- "type": "array",
- "items": {
- "$ref": "SideInputInfo"
- }
+ "name": {
+ "description": "Name of the counter.",
+ "type": "string"
},
+ "kind": {
+ "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."
+ ],
+ "enum": [
+ "INVALID",
+ "SUM",
+ "MAX",
+ "MIN",
+ "MEAN",
+ "OR",
+ "AND",
+ "SET",
+ "DISTRIBUTION"
+ ],
+ "description": "Counter aggregation kind.",
+ "type": "string"
+ }
+ },
+ "id": "NameAndKind"
+ },
+ "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"
@@ -2266,48 +2265,16 @@
"items": {
"$ref": "SeqMapTaskOutputInfo"
}
- }
- },
- "id": "SeqMapTask",
- "description": "Describes a particular function to invoke.",
- "type": "object"
- },
- "NameAndKind": {
- "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."
- ]
+ "inputs": {
+ "description": "Information about each of the inputs.",
+ "type": "array",
+ "items": {
+ "$ref": "SideInputInfo"
+ }
}
},
- "id": "NameAndKind",
- "description": "Basic metadata about a counter.",
- "type": "object"
+ "id": "SeqMapTask"
},
"WorkerMessageCode": {
"properties": {
@@ -2329,17 +2296,19 @@
"type": "object"
},
"CustomSourceLocation": {
+ "description": "Identifies the location of a custom souce.",
+ "type": "object",
"properties": {
"stateful": {
"description": "Whether this source is stateful.",
"type": "boolean"
}
},
- "id": "CustomSourceLocation",
- "description": "Identifies the location of a custom souce.",
- "type": "object"
+ "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.",
@@ -2357,25 +2326,23 @@
}
}
},
- "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.",
- "type": "object"
+ "id": "MapTask"
},
"FloatingPointMean": {
- "description": "A representation of a floating point mean metric contribution.",
- "type": "object",
"properties": {
+ "count": {
+ "description": "The number of values being aggregated.",
+ "$ref": "SplitInt64"
+ },
"sum": {
"description": "The sum of all values being aggregated.",
"format": "double",
"type": "number"
- },
- "count": {
- "$ref": "SplitInt64",
- "description": "The number of values being aggregated."
}
},
- "id": "FloatingPointMean"
+ "id": "FloatingPointMean",
+ "description": "A representation of a floating point mean metric contribution.",
+ "type": "object"
},
"ReportWorkItemStatusResponse": {
"description": "Response from a request to report the status of WorkItems.",
@@ -2392,25 +2359,15 @@
"id": "ReportWorkItemStatusResponse"
},
"InstructionOutput": {
- "description": "An output of an instruction.",
- "type": "object",
"properties": {
- "name": {
- "description": "The user-provided name of this output.",
- "type": "string"
- },
- "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.",
+ "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"
},
- "systemName": {
- "description": "System-defined name of this output.\nUnique across the workflow.",
- "type": "string"
- },
"onlyCountValueBytes": {
"description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the value size.",
"type": "boolean"
@@ -2422,13 +2379,21 @@
},
"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"
+ },
+ "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"
+ "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": {
@@ -2446,42 +2411,35 @@
"type": "string"
},
"environment": {
- "$ref": "RuntimeEnvironment",
- "description": "The runtime environment for the job."
+ "description": "The runtime environment for the job.",
+ "$ref": "RuntimeEnvironment"
},
"location": {
"description": "The location to which to direct the request.",
"type": "string"
}
},
- "id": "CreateJobFromTemplateRequest"
+ "id": "CreateJobFromTemplateRequest",
+ "description": "A request to create a Cloud Dataflow job from a template.",
+ "type": "object"
},
"IntegerMean": {
"description": "A representation of an integer mean metric contribution.",
"type": "object",
"properties": {
+ "sum": {
+ "$ref": "SplitInt64",
+ "description": "The sum of all values being aggregated."
+ },
"count": {
"$ref": "SplitInt64",
"description": "The number of values being aggregated."
- },
- "sum": {
- "description": "The sum of all values being aggregated.",
- "$ref": "SplitInt64"
}
},
"id": "IntegerMean"
},
"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",
"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"
@@ -2492,12 +2450,35 @@
"items": {
"$ref": "FailedLocation"
}
+ },
+ "jobs": {
+ "description": "A subset of the requested job information.",
+ "type": "array",
+ "items": {
+ "$ref": "Job"
+ }
}
},
- "id": "ListJobsResponse"
+ "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": {
"properties": {
+ "stateFamilies": {
+ "description": "The state family values.",
+ "type": "array",
+ "items": {
+ "$ref": "StateFamilyConfig"
+ }
+ },
+ "outputs": {
+ "description": "The outputs from the computation.",
+ "type": "array",
+ "items": {
+ "$ref": "StreamLocation"
+ }
+ },
"systemStageName": {
"description": "The system stage name.",
"type": "string"
@@ -2519,20 +2500,6 @@
"items": {
"$ref": "KeyRangeLocation"
}
- },
- "stateFamilies": {
- "description": "The state family values.",
- "type": "array",
- "items": {
- "$ref": "StateFamilyConfig"
- }
- },
- "outputs": {
- "description": "The outputs from the computation.",
- "type": "array",
- "items": {
- "$ref": "StreamLocation"
- }
}
},
"id": "ComputationTopology",
@@ -2540,11 +2507,9 @@
"type": "object"
},
"RuntimeEnvironment": {
+ "description": "The environment values to set at runtime.",
+ "type": "object",
"properties": {
- "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"
@@ -2554,10 +2519,6 @@
"format": "int32",
"type": "integer"
},
- "bypassTempDirValidation": {
- "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.",
- "type": "boolean"
- },
"serviceAccountEmail": {
"description": "The email address of the service account to run the job as.",
"type": "string"
@@ -2565,11 +2526,17 @@
"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"
}
},
- "id": "RuntimeEnvironment",
- "description": "The environment values to set at runtime.",
- "type": "object"
+ "id": "RuntimeEnvironment"
},
"StreamingSideInputLocation": {
"description": "Identifies the location of a streaming side input.",
@@ -2598,26 +2565,85 @@
"type": "object"
},
"LaunchTemplateResponse": {
- "description": "Response to the request to launch a template.",
- "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"
+ "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": {
+ "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).",
+ "type": "string"
+ },
+ "source": {
+ "$ref": "Source",
+ "description": "Specification of the 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": {
+ "description": "Residual part (returned to the pool of work).\nSpecified relative to the previously-current source.",
+ "$ref": "DerivedSource"
+ }
+ },
+ "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": {
- "executionInfo": {
- "description": "Deprecated.",
- "$ref": "JobExecutionInfo"
+ "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"
+ }
},
"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"
},
+ "executionInfo": {
+ "description": "Deprecated.",
+ "$ref": "JobExecutionInfo"
+ },
"currentState": {
"enumDescriptions": [
"The job's run state isn't specified.",
@@ -2664,6 +2690,15 @@
"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"
@@ -2671,15 +2706,6 @@
"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"
},
- "environment": {
- "$ref": "Environment",
- "description": "The environment for the job."
- },
- "createTime": {
- "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service.",
- "format": "google-datetime",
- "type": "string"
- },
"stageStates": {
"description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.",
"type": "array",
@@ -2692,18 +2718,18 @@
"type": "string"
},
"type": {
+ "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."
+ ],
"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."
- ]
+ "type": "string"
},
"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.",
@@ -2753,93 +2779,26 @@
"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"
- },
- "steps": {
- "description": "The top-level steps that constitute the entire job.",
- "type": "array",
- "items": {
- "$ref": "Step"
- }
- },
- "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"
}
},
- "id": "Job",
- "description": "Defines a job to be run by the Cloud Dataflow service.",
- "type": "object"
- },
- "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": {
- "residual": {
- "$ref": "DerivedSource",
- "description": "Residual part (returned to the pool of work).\nSpecified relative to the previously-current source."
- },
- "primary": {
- "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current.",
- "$ref": "DerivedSource"
- }
- },
- "id": "DynamicSourceSplit"
- },
- "DerivedSource": {
- "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": {
- "$ref": "Source",
- "description": "Specification of the source."
- }
- },
- "id": "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"
+ "id": "Job"
},
"SourceOperationResponse": {
"properties": {
"getMetadata": {
- "description": "A response to a request to get metadata about a source.",
- "$ref": "SourceGetMetadataResponse"
+ "$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."
+ "description": "A response to a request to split a source.",
+ "$ref": "SourceSplitResponse"
}
},
"id": "SourceOperationResponse",
"description": "The result of a SourceOperationRequest, specified in\nReportWorkItemStatusRequest.source_operation when the work item\nis completed.",
"type": "object"
},
- "SendDebugCaptureResponse": {
- "description": "Response to a send capture request.\nnothing",
- "type": "object",
- "properties": {},
- "id": "SendDebugCaptureResponse"
- },
"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.",
@@ -2861,7 +2820,46 @@
"type": "string"
}
},
- "id": "SideInputInfo"
+ "id": "SideInputInfo",
+ "description": "Information about a side input of a DoFn or an input of a SeqDoFn.",
+ "type": "object"
+ },
+ "SendDebugCaptureResponse": {
+ "properties": {},
+ "id": "SendDebugCaptureResponse",
+ "description": "Response to a send capture request.\nnothing",
+ "type": "object"
+ },
+ "WriteInstruction": {
+ "description": "An instruction that writes records.\nTakes one input, produces no outputs.",
+ "type": "object",
+ "properties": {
+ "input": {
+ "description": "The input.",
+ "$ref": "InstructionInput"
+ },
+ "sink": {
+ "description": "The sink to write to.",
+ "$ref": "Sink"
+ }
+ },
+ "id": "WriteInstruction"
+ },
+ "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": {
+ "$ref": "Position",
+ "description": "Position within the inner source."
+ },
+ "index": {
+ "description": "Index of the inner source.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ConcatPosition"
},
"CounterStructuredNameAndMetadata": {
"description": "A single message which encapsulates structured name and metadata for a given\ncounter.",
@@ -2872,63 +2870,21 @@
"$ref": "CounterStructuredName"
},
"metadata": {
- "description": "Metadata associated with a counter",
- "$ref": "CounterMetadata"
+ "$ref": "CounterMetadata",
+ "description": "Metadata associated with a counter"
}
},
"id": "CounterStructuredNameAndMetadata"
},
- "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.",
+ "AutoscalingSettings": {
+ "description": "Settings for WorkerPool autoscaling.",
"type": "object",
"properties": {
- "position": {
- "description": "Position within the inner source.",
- "$ref": "Position"
- },
- "index": {
- "description": "Index of the inner source.",
+ "maxNumWorkers": {
+ "description": "The maximum number of workers to cap scaling at.",
"format": "int32",
"type": "integer"
- }
- },
- "id": "ConcatPosition"
- },
- "WriteInstruction": {
- "properties": {
- "input": {
- "$ref": "InstructionInput",
- "description": "The input."
},
- "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"
- },
- "StreamingComputationRanges": {
- "description": "Describes full or partial data disk assignment information of the computation\nranges.",
- "type": "object",
- "properties": {
- "rangeAssignments": {
- "description": "Data disk assignments for ranges from this computation.",
- "type": "array",
- "items": {
- "$ref": "KeyRangeDataDiskAssignment"
- }
- },
- "computationId": {
- "description": "The ID of the computation.",
- "type": "string"
- }
- },
- "id": "StreamingComputationRanges"
- },
- "AutoscalingSettings": {
- "properties": {
"algorithm": {
"enum": [
"AUTOSCALING_ALGORITHM_UNKNOWN",
@@ -2942,30 +2898,30 @@
"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",
- "description": "Settings for WorkerPool autoscaling.",
+ "id": "AutoscalingSettings"
+ },
+ "StreamingComputationRanges": {
+ "properties": {
+ "rangeAssignments": {
+ "description": "Data disk assignments for ranges from this computation.",
+ "type": "array",
+ "items": {
+ "$ref": "KeyRangeDataDiskAssignment"
+ }
+ },
+ "computationId": {
+ "description": "The ID of the computation.",
+ "type": "string"
+ }
+ },
+ "id": "StreamingComputationRanges",
+ "description": "Describes full or partial data disk assignment information of the computation\nranges.",
"type": "object"
},
"ExecutionStageSummary": {
"properties": {
- "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",
@@ -2974,6 +2930,17 @@
}
},
"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",
@@ -2986,18 +2953,7 @@
"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."
- ]
+ "type": "string"
},
"outputSource": {
"description": "Output sources for this stage.",
@@ -3016,6 +2972,17 @@
"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"
+ }
}
},
"id": "ExecutionStageSummary",
@@ -3023,8 +2990,6 @@
"type": "object"
},
"SendWorkerMessagesRequest": {
- "description": "A request for sending worker messages to the service.",
- "type": "object",
"properties": {
"workerMessages": {
"description": "The WorkerMessages to send.",
@@ -3038,7 +3003,9 @@
"type": "string"
}
},
- "id": "SendWorkerMessagesRequest"
+ "id": "SendWorkerMessagesRequest",
+ "description": "A request for sending worker messages to the service.",
+ "type": "object"
},
"SourceSplitShard": {
"properties": {
@@ -3068,6 +3035,8 @@
"type": "object"
},
"CPUTime": {
+ "description": "Modeled after information exposed by /proc/stat.",
+ "type": "object",
"properties": {
"totalMs": {
"description": "Total active CPU time across all cores (ie., non-idle) in milliseconds\nsince start-up.",
@@ -3085,14 +3054,28 @@
"type": "string"
}
},
- "id": "CPUTime",
- "description": "Modeled after information exposed by /proc/stat.",
- "type": "object"
+ "id": "CPUTime"
},
"Environment": {
"description": "Describes the environment in which a Dataflow Job runs.",
"type": "object",
"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"
@@ -3138,42 +3121,14 @@
"serviceAccountEmail": {
"description": "Identity to run virtual machines as. Defaults to the default account.",
"type": "string"
- },
- "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"
}
},
"id": "Environment"
},
"StreamingComputationTask": {
+ "description": "A task which describes what action should be performed for the specified\nstreaming computation ranges.",
+ "type": "object",
"properties": {
- "taskType": {
- "enum": [
- "STREAMING_COMPUTATION_TASK_UNKNOWN",
- "STREAMING_COMPUTATION_TASK_STOP",
- "STREAMING_COMPUTATION_TASK_START"
- ],
- "description": "A type of streaming computation task.",
- "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)."
- ]
- },
"computationRanges": {
"description": "Contains ranges of a streaming computation this task should apply to.",
"type": "array",
@@ -3187,11 +3142,23 @@
"items": {
"$ref": "MountedDataDisk"
}
+ },
+ "taskType": {
+ "enum": [
+ "STREAMING_COMPUTATION_TASK_UNKNOWN",
+ "STREAMING_COMPUTATION_TASK_STOP",
+ "STREAMING_COMPUTATION_TASK_START"
+ ],
+ "description": "A type of streaming computation task.",
+ "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)."
+ ]
}
},
- "id": "StreamingComputationTask",
- "description": "A task which describes what action should be performed for the specified\nstreaming computation ranges.",
- "type": "object"
+ "id": "StreamingComputationTask"
},
"SendDebugCaptureRequest": {
"properties": {
@@ -3228,6 +3195,8 @@
"type": "object"
},
"ComponentTransform": {
+ "description": "Description of a transform executed as part of an execution stage.",
+ "type": "object",
"properties": {
"originalTransform": {
"description": "User name for the original user transform with which this transform is\nmost closely associated.",
@@ -3242,9 +3211,7 @@
"type": "string"
}
},
- "id": "ComponentTransform",
- "description": "Description of a transform executed as part of an execution stage.",
- "type": "object"
+ "id": "ComponentTransform"
},
"StreamingSetupTask": {
"description": "A task which initializes part of a streaming Dataflow job.",
@@ -3265,18 +3232,14 @@
"type": "integer"
},
"streamingComputationTopology": {
- "description": "The global topology of the streaming Dataflow job.",
- "$ref": "TopologyConfig"
+ "$ref": "TopologyConfig",
+ "description": "The global topology of the streaming Dataflow job."
}
},
"id": "StreamingSetupTask"
},
"PubsubLocation": {
"properties": {
- "trackingSubscription": {
- "description": "If set, specifies the pubsub subscription that will be used for tracking\ncustom time timestamps for watermark estimation.",
- "type": "string"
- },
"withAttributes": {
"description": "If true, then the client has requested to get pubsub attributes.",
"type": "boolean"
@@ -3300,6 +3263,10 @@
"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",
@@ -3351,14 +3318,6 @@
"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",
@@ -3368,7 +3327,15 @@
"JOB_MESSAGE_ERROR"
],
"description": "Importance level of the message.",
- "type": "string"
+ "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."
+ ]
},
"time": {
"description": "The timestamp of the message.",
@@ -3379,8 +3346,6 @@
"id": "JobMessage"
},
"ParameterMetadata": {
- "description": "Metadata for a specific parameter.",
- "type": "object",
"properties": {
"isOptional": {
"description": "Optional. Whether the parameter is optional. Defaults to false.",
@@ -3406,7 +3371,9 @@
"type": "string"
}
},
- "id": "ParameterMetadata"
+ "id": "ParameterMetadata",
+ "description": "Metadata for a specific parameter.",
+ "type": "object"
},
"MultiOutputInfo": {
"description": "Information about an output of a multi-output DoFn.",
@@ -3428,37 +3395,65 @@
"description": "Specification of the source to be split."
},
"options": {
- "description": "Hints for tuning the splitting process.",
- "$ref": "SourceSplitOptions"
+ "$ref": "SourceSplitOptions",
+ "description": "Hints for tuning the splitting process."
}
},
"id": "SourceSplitRequest"
},
"SourceGetMetadataResponse": {
+ "description": "The result of a SourceGetMetadataOperation.",
+ "type": "object",
"properties": {
"metadata": {
"$ref": "SourceMetadata",
"description": "The computed metadata."
}
},
- "id": "SourceGetMetadataResponse",
- "description": "The result of a SourceGetMetadataOperation.",
- "type": "object"
+ "id": "SourceGetMetadataResponse"
},
- "ShellTask": {
+ "AutoscalingEvent": {
"properties": {
- "command": {
- "description": "The shell command to run.",
+ "targetNumWorkers": {
+ "description": "The target number of workers the worker pool wants to resize to use.",
+ "format": "int64",
"type": "string"
},
- "exitCode": {
- "description": "Exit code for the task.",
- "format": "int32",
- "type": "integer"
+ "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."
+ ]
+ },
+ "currentNumWorkers": {
+ "description": "The current number of workers the job has.",
+ "format": "int64",
+ "type": "string"
+ },
+ "description": {
+ "description": "A message describing why the system decided to adjust the current\nnumber of workers, why it failed, or why the system decided to\nnot make any changes to the number of workers.",
+ "$ref": "StructuredMessage"
+ },
+ "time": {
+ "description": "The time this event was emitted to indicate a new target or current\nnum_workers value.",
+ "format": "google-datetime",
+ "type": "string"
}
},
- "id": "ShellTask",
- "description": "A task which consists of a shell command for the worker to execute.",
+ "id": "AutoscalingEvent",
+ "description": "A structured message reporting an autoscaling decision made by the Dataflow\nservice.",
"type": "object"
},
"MetricShortId": {
@@ -3478,54 +3473,40 @@
"description": "The metric short id is returned to the user alongside an offset into\nReportWorkItemStatusRequest",
"type": "object"
},
- "AutoscalingEvent": {
- "properties": {
- "description": {
- "$ref": "StructuredMessage",
- "description": "A message describing why the system decided to adjust the current\nnumber of workers, why it failed, or why the system decided to\nnot make any changes to the number of workers."
- },
- "time": {
- "description": "The time this event was emitted to indicate a new target or current\nnum_workers value.",
- "format": "google-datetime",
- "type": "string"
- },
- "targetNumWorkers": {
- "description": "The target number of workers the worker pool wants to resize to use.",
- "format": "int64",
- "type": "string"
- },
- "eventType": {
- "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.",
- "type": "string"
- },
- "currentNumWorkers": {
- "description": "The current number of workers the job has.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "AutoscalingEvent",
- "description": "A structured message reporting an autoscaling decision made by the Dataflow\nservice.",
- "type": "object"
- },
- "TaskRunnerSettings": {
- "description": "Taskrunner configuration settings.",
+ "ShellTask": {
+ "description": "A task which consists of a shell command for the worker to execute.",
"type": "object",
"properties": {
+ "command": {
+ "description": "The shell command to run.",
+ "type": "string"
+ },
+ "exitCode": {
+ "description": "Exit code for the task.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ShellTask"
+ },
+ "TaskRunnerSettings": {
+ "properties": {
+ "vmId": {
+ "description": "The ID string of the VM.",
+ "type": "string"
+ },
+ "taskUser": {
+ "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\".",
+ "type": "string"
+ },
+ "alsologtostderr": {
+ "description": "Whether to also send taskrunner log info to stderr.",
+ "type": "boolean"
+ },
+ "taskGroup": {
+ "description": "The UNIX group ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"wheel\".",
+ "type": "string"
+ },
"harnessCommand": {
"description": "The command to launch the worker harness.",
"type": "string"
@@ -3588,37 +3569,14 @@
"parallelWorkerSettings": {
"description": "The settings to pass to the parallel worker harness.",
"$ref": "WorkerSettings"
- },
- "vmId": {
- "description": "The ID string of the VM.",
- "type": "string"
- },
- "taskUser": {
- "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\".",
- "type": "string"
- },
- "alsologtostderr": {
- "description": "Whether to also send taskrunner log info to stderr.",
- "type": "boolean"
- },
- "taskGroup": {
- "description": "The UNIX group ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"wheel\".",
- "type": "string"
}
},
- "id": "TaskRunnerSettings"
+ "id": "TaskRunnerSettings",
+ "description": "Taskrunner configuration settings.",
+ "type": "object"
},
"Position": {
"properties": {
- "key": {
- "description": "Position is a string key, ordered lexicographically.",
- "type": "string"
- },
- "recordIndex": {
- "description": "Position is a record index.",
- "format": "int64",
- "type": "string"
- },
"shufflePosition": {
"description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED\nsharding).",
"type": "string"
@@ -3635,15 +3593,39 @@
"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"
+ },
+ "recordIndex": {
+ "description": "Position is a record index.",
+ "format": "int64",
+ "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.",
"type": "object"
},
+ "SplitInt64": {
+ "properties": {
+ "lowBits": {
+ "description": "The low order bits: n & 0xffffffff.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "highBits": {
+ "description": "The high order bits, including the sign: n \u003e\u003e 32.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "SplitInt64",
+ "description": "A representation of an int64, n, that is immune to precision loss when\nencoded in JSON.",
+ "type": "object"
+ },
"Source": {
- "description": "A source that records can be read and decoded from.",
- "type": "object",
"properties": {
"spec": {
"additionalProperties": {
@@ -3681,60 +3663,23 @@
"type": "boolean"
}
},
- "id": "Source"
- },
- "SplitInt64": {
- "properties": {
- "lowBits": {
- "description": "The low order bits: n & 0xffffffff.",
- "format": "uint32",
- "type": "integer"
- },
- "highBits": {
- "description": "The high order bits, including the sign: n \u003e\u003e 32.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "SplitInt64",
- "description": "A representation of an int64, n, that is immune to precision loss when\nencoded in JSON.",
+ "id": "Source",
+ "description": "A source that records can be read and decoded from.",
"type": "object"
},
"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.",
- "type": "object",
"properties": {
- "network": {
- "description": "Network to which VMs will be assigned. If empty or unspecified,\nthe service will use the network \"default\".",
- "type": "string"
- },
- "defaultPackageSet": {
- "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.",
- "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."
- ]
- },
"zone": {
"description": "Zone to run the worker pools in. If empty or unspecified, the service\nwill attempt to choose a reasonable default.",
"type": "string"
},
- "numThreadsPerWorker": {
- "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).",
+ "numWorkers": {
+ "description": "Number of Google Compute Engine workers in this pool needed to\nexecute the job. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
"format": "int32",
"type": "integer"
},
- "numWorkers": {
- "description": "Number of Google Compute Engine workers in this pool needed to\nexecute the job. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
+ "numThreadsPerWorker": {
+ "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"
},
@@ -3823,23 +3768,45 @@
"description": "Configuration for VM IPs.",
"type": "string"
},
- "autoscalingSettings": {
- "$ref": "AutoscalingSettings",
- "description": "Settings for autoscaling of this WorkerPool."
- },
"taskrunnerSettings": {
"$ref": "TaskRunnerSettings",
"description": "Settings passed through to Google Compute Engine workers when\nusing the standard Dataflow task runner. Users should ignore\nthis field."
},
+ "autoscalingSettings": {
+ "description": "Settings for autoscaling of this WorkerPool.",
+ "$ref": "AutoscalingSettings"
+ },
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Metadata to set on the Google Compute Engine VMs.",
"type": "object"
+ },
+ "defaultPackageSet": {
+ "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.",
+ "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"
}
},
- "id": "WorkerPool"
+ "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.",
+ "type": "object"
},
"SourceOperationRequest": {
"description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification.",
@@ -3874,6 +3841,10 @@
},
"StructuredMessage": {
"properties": {
+ "messageKey": {
+ "description": "Idenfier for this message type. Used by external systems to\ninternationalize or personalize message.",
+ "type": "string"
+ },
"messageText": {
"description": "Human-readable version of message.",
"type": "string"
@@ -3884,10 +3855,6 @@
"items": {
"$ref": "Parameter"
}
- },
- "messageKey": {
- "description": "Idenfier for this message type. Used by external systems to\ninternationalize or personalize message.",
- "type": "string"
}
},
"id": "StructuredMessage",
@@ -3908,8 +3875,8 @@
"type": "string"
},
"streamingSetupTask": {
- "description": "Additional information for StreamingSetupTask WorkItems.",
- "$ref": "StreamingSetupTask"
+ "$ref": "StreamingSetupTask",
+ "description": "Additional information for StreamingSetupTask WorkItems."
},
"sourceOperationTask": {
"description": "Additional information for source operation WorkItems.",
@@ -3930,12 +3897,12 @@
"type": "string"
},
"streamingComputationTask": {
- "$ref": "StreamingComputationTask",
- "description": "Additional information for StreamingComputationTask WorkItems."
+ "description": "Additional information for StreamingComputationTask WorkItems.",
+ "$ref": "StreamingComputationTask"
},
"shellTask": {
- "description": "Additional information for ShellTask WorkItems.",
- "$ref": "ShellTask"
+ "$ref": "ShellTask",
+ "description": "Additional information for ShellTask WorkItems."
},
"jobId": {
"description": "Identifies the workflow job this WorkItem belongs to.",
@@ -3955,8 +3922,8 @@
"description": "Additional information for MapTask WorkItems."
},
"seqMapTask": {
- "description": "Additional information for SeqMapTask WorkItems.",
- "$ref": "SeqMapTask"
+ "$ref": "SeqMapTask",
+ "description": "Additional information for SeqMapTask WorkItems."
},
"packages": {
"description": "Any required packages that need to be fetched in order to execute\nthis WorkItem.",
@@ -3969,6 +3936,8 @@
"id": "WorkItem"
},
"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",
"properties": {
"cpuTime": {
"description": "CPU utilization samples.",
@@ -3978,20 +3947,18 @@
}
}
},
- "id": "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"
+ "id": "ResourceUtilizationReport"
},
"ReportedParallelism": {
"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"
+ },
+ "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"
}
},
"id": "ReportedParallelism",
@@ -4037,6 +4004,8 @@
"id": "TopologyConfig"
},
"SourceSplitOptions": {
+ "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest.",
+ "type": "object",
"properties": {
"desiredBundleSizeBytes": {
"description": "The source should be split into a set of bundles where the estimated size\nof each is approximately this many bytes.",
@@ -4049,31 +4018,23 @@
"type": "string"
}
},
- "id": "SourceSplitOptions",
- "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest.",
- "type": "object"
+ "id": "SourceSplitOptions"
},
"ReadInstruction": {
+ "description": "An instruction that reads records.\nTakes no inputs, produces one output.",
+ "type": "object",
"properties": {
"source": {
"description": "The source to read from.",
"$ref": "Source"
}
},
- "id": "ReadInstruction",
- "description": "An instruction that reads records.\nTakes no inputs, produces one output.",
- "type": "object"
+ "id": "ReadInstruction"
},
"WorkerSettings": {
+ "description": "Provides data to pass through to the worker harness.",
+ "type": "object",
"properties": {
- "workerId": {
- "description": "The ID of the worker running this pipeline.",
- "type": "string"
- },
- "tempStoragePrefix": {
- "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}",
- "type": "string"
- },
"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"
@@ -4089,11 +4050,17 @@
"shuffleServicePath": {
"description": "The Shuffle service path relative to the root URL, for example,\n\"shuffle/v1beta1\".",
"type": "string"
+ },
+ "workerId": {
+ "description": "The ID of the worker running this pipeline.",
+ "type": "string"
+ },
+ "tempStoragePrefix": {
+ "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}",
+ "type": "string"
}
},
- "id": "WorkerSettings",
- "description": "Provides data to pass through to the worker harness.",
- "type": "object"
+ "id": "WorkerSettings"
},
"DataDiskAssignment": {
"properties": {
@@ -4126,14 +4093,14 @@
},
"ApproximateSplitRequest": {
"properties": {
+ "position": {
+ "$ref": "Position",
+ "description": "A Position at which to split the work item."
+ },
"fractionConsumed": {
"description": "A fraction at which to split the work item, from 0.0 (beginning of the\ninput) to 1.0 (end of the input).",
"format": "double",
"type": "number"
- },
- "position": {
- "$ref": "Position",
- "description": "A Position at which to split the work item."
}
},
"id": "ApproximateSplitRequest",
@@ -4141,7 +4108,13 @@
"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",
@@ -4157,28 +4130,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",
- "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"
},
"ExecutionStageState": {
"properties": {
- "executionStageName": {
- "description": "The name of the execution stage.",
- "type": "string"
- },
- "currentStateTime": {
- "description": "The time at which the stage transitioned to this state.",
- "format": "google-datetime",
- "type": "string"
- },
"executionStageState": {
+ "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",
@@ -4193,20 +4164,16 @@
"JOB_STATE_CANCELLING"
],
"description": "Executions stage states allow the same set of values as JobState.",
- "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'."
- ]
+ "type": "string"
+ },
+ "executionStageName": {
+ "description": "The name of the execution stage.",
+ "type": "string"
+ },
+ "currentStateTime": {
+ "description": "The time at which the stage transitioned to this state.",
+ "format": "google-datetime",
+ "type": "string"
}
},
"id": "ExecutionStageState",
@@ -4214,29 +4181,31 @@
"type": "object"
},
"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": {
- "$ref": "CustomSourceLocation",
- "description": "The stream is a custom source."
- },
"streamingStageLocation": {
"$ref": "StreamingStageLocation",
"description": "The stream is part of another computation within the current\nstreaming Dataflow job."
},
"pubsubLocation": {
- "description": "The stream is a pubsub stream.",
- "$ref": "PubsubLocation"
+ "$ref": "PubsubLocation",
+ "description": "The stream is a pubsub stream."
},
"sideInputLocation": {
"description": "The stream is a streaming side input.",
"$ref": "StreamingSideInputLocation"
+ },
+ "customSourceLocation": {
+ "$ref": "CustomSourceLocation",
+ "description": "The stream is a custom source."
}
},
- "id": "StreamLocation"
+ "id": "StreamLocation",
+ "description": "Describes a stream of data, either as input to be processed or as\noutput of a streaming Dataflow job.",
+ "type": "object"
},
"SendWorkerMessagesResponse": {
+ "description": "The response to the worker messages.",
+ "type": "object",
"properties": {
"workerMessageResponses": {
"description": "The servers response to the worker messages.",
@@ -4246,18 +4215,12 @@
}
}
},
- "id": "SendWorkerMessagesResponse",
- "description": "The response to the worker messages.",
- "type": "object"
+ "id": "SendWorkerMessagesResponse"
},
"StreamingComputationConfig": {
"description": "Configuration information for a single streaming computation.",
"type": "object",
"properties": {
- "computationId": {
- "description": "Unique identifier for this computation.",
- "type": "string"
- },
"systemName": {
"description": "System defined name for this computation.",
"type": "string"
@@ -4272,19 +4235,18 @@
"items": {
"$ref": "ParallelInstruction"
}
+ },
+ "computationId": {
+ "description": "Unique identifier for this computation.",
+ "type": "string"
}
},
"id": "StreamingComputationConfig"
},
"TransformSummary": {
+ "description": "Description of the type, names/ids, and input/outputs for a transform.",
+ "type": "object",
"properties": {
- "inputCollectionName": {
- "description": "User names for all collection inputs to this transform.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"name": {
"description": "User provided name for this transform instance.",
"type": "string"
@@ -4308,17 +4270,6 @@
}
},
"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",
@@ -4331,14 +4282,32 @@
"SHUFFLE_KIND"
],
"description": "Type of transform.",
- "type": "string"
+ "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."
+ ]
+ },
+ "inputCollectionName": {
+ "description": "User names for all collection inputs to this transform.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
- "id": "TransformSummary",
- "description": "Description of the type, names/ids, and input/outputs for a transform.",
- "type": "object"
+ "id": "TransformSummary"
},
"LeaseWorkItemResponse": {
+ "description": "Response to a request to lease WorkItems.",
+ "type": "object",
"properties": {
"workItems": {
"description": "A list of the leased WorkItems.",
@@ -4348,9 +4317,7 @@
}
}
},
- "id": "LeaseWorkItemResponse",
- "description": "Response to a request to lease WorkItems.",
- "type": "object"
+ "id": "LeaseWorkItemResponse"
},
"LaunchTemplateParameters": {
"description": "Parameters to provide to the template being launched.",
@@ -4368,15 +4335,13 @@
"type": "string"
},
"environment": {
- "description": "The runtime environment for the job.",
- "$ref": "RuntimeEnvironment"
+ "$ref": "RuntimeEnvironment",
+ "description": "The runtime environment for the job."
}
},
"id": "LaunchTemplateParameters"
},
"Sink": {
- "description": "A sink that records can be encoded and written to.",
- "type": "object",
"properties": {
"spec": {
"additionalProperties": {
@@ -4395,7 +4360,9 @@
"type": "object"
}
},
- "id": "Sink"
+ "id": "Sink",
+ "description": "A sink that records can be encoded and written to.",
+ "type": "object"
},
"FlattenInstruction": {
"properties": {
@@ -4413,6 +4380,10 @@
},
"PartialGroupByKeyInstruction": {
"properties": {
+ "input": {
+ "$ref": "InstructionInput",
+ "description": "Describes the input to the partial group-by-key instruction."
+ },
"inputElementCodec": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -4433,20 +4404,16 @@
"description": "If this instruction includes a combining function this is the name of the\nintermediate store between the GBK and the CombineValues.",
"type": "string"
},
+ "originalCombineValuesStepName": {
+ "description": "If this instruction includes a combining function, this is the name of the\nCombineValues instruction lifted into this instruction.",
+ "type": "string"
+ },
"sideInputs": {
"description": "Zero or more side inputs.",
"type": "array",
"items": {
"$ref": "SideInputInfo"
}
- },
- "originalCombineValuesStepName": {
- "description": "If this instruction includes a combining function, this is the name of the\nCombineValues instruction lifted into this instruction.",
- "type": "string"
- },
- "input": {
- "$ref": "InstructionInput",
- "description": "Describes the input to the partial group-by-key instruction."
}
},
"id": "PartialGroupByKeyInstruction",
@@ -4478,6 +4445,8 @@
"id": "StageSource"
},
"InstructionInput": {
+ "description": "An input of an instruction, as a reference to an output of a\nproducer instruction.",
+ "type": "object",
"properties": {
"producerInstructionIndex": {
"description": "The index (origin zero) of the parallel instruction that produces\nthe output to be consumed by this input. This index is relative\nto the list of instructions in this input's instruction's\ncontaining MapTask.",
@@ -4490,9 +4459,7 @@
"type": "integer"
}
},
- "id": "InstructionInput",
- "description": "An input of an instruction, as a reference to an output of a\nproducer instruction.",
- "type": "object"
+ "id": "InstructionInput"
},
"StringList": {
"properties": {
@@ -4512,41 +4479,14 @@
"description": "Data provided with a pipeline or transform to provide descriptive info.",
"type": "object",
"properties": {
- "durationValue": {
- "description": "Contains value if the data is of duration type.",
- "format": "google-duration",
- "type": "string"
- },
- "int64Value": {
- "description": "Contains value if the data is of int64 type.",
- "format": "int64",
- "type": "string"
- },
- "namespace": {
- "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.",
- "type": "string"
- },
- "floatValue": {
- "description": "Contains value if the data is of float type.",
- "format": "float",
- "type": "number"
- },
- "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"
- },
- "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.",
+ "url": {
+ "description": "An optional full URL.",
"type": "string"
},
"label": {
"description": "An optional label to display in a dax UI for the element.",
"type": "string"
},
- "url": {
- "description": "An optional full URL.",
- "type": "string"
- },
"timestampValue": {
"description": "Contains value if the data is of timestamp type.",
"format": "google-datetime",
@@ -4563,11 +4503,40 @@
"strValue": {
"description": "Contains value if the data is of string type.",
"type": "string"
+ },
+ "int64Value": {
+ "description": "Contains value if the data is of int64 type.",
+ "format": "int64",
+ "type": "string"
+ },
+ "durationValue": {
+ "description": "Contains value if the data is of duration type.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "namespace": {
+ "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.",
+ "type": "string"
+ },
+ "floatValue": {
+ "description": "Contains value if the data is of float type.",
+ "format": "float",
+ "type": "number"
+ },
+ "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"
+ },
+ "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"
}
},
"id": "DisplayData"
},
"GetDebugConfigRequest": {
+ "description": "Request to get updated debug configuration for component.",
+ "type": "object",
"properties": {
"componentId": {
"description": "The internal component id for which debug configuration is\nrequested.",
@@ -4582,13 +4551,9 @@
"type": "string"
}
},
- "id": "GetDebugConfigRequest",
- "description": "Request to get updated debug configuration for component.",
- "type": "object"
+ "id": "GetDebugConfigRequest"
},
"LeaseWorkItemRequest": {
- "description": "Request to lease WorkItems.",
- "type": "object",
"properties": {
"workerCapabilities": {
"description": "Worker capabilities. WorkItems might be limited to workers with specific\ncapabilities.",
@@ -4611,38 +4576,38 @@
"format": "google-datetime",
"type": "string"
},
- "location": {
- "description": "The location which contains the WorkItem's job.",
- "type": "string"
- },
"workItemTypes": {
"description": "Filter for WorkItem type.",
"type": "array",
"items": {
"type": "string"
}
+ },
+ "location": {
+ "description": "The location which contains the WorkItem's job.",
+ "type": "string"
}
},
- "id": "LeaseWorkItemRequest"
+ "id": "LeaseWorkItemRequest",
+ "description": "Request to lease WorkItems.",
+ "type": "object"
},
"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": {
"description": "The status of the get template request. Any problems with the\nrequest will be indicated in the error_details.",
"$ref": "Status"
+ },
+ "metadata": {
+ "description": "The template metadata describing the template name, available\nparameters, etc.",
+ "$ref": "TemplateMetadata"
}
},
"id": "GetTemplateResponse"
},
"Parameter": {
- "description": "Structured data associated with this message.",
- "type": "object",
"properties": {
"value": {
"description": "Value for this parameter.",
@@ -4653,17 +4618,12 @@
"type": "string"
}
},
- "id": "Parameter"
+ "id": "Parameter",
+ "description": "Structured data associated with this message.",
+ "type": "object"
},
"ReportWorkItemStatusRequest": {
"properties": {
- "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"
- }
- },
"workerId": {
"description": "The ID of the worker reporting the WorkItem status. If this\ndoes not match the ID of the worker which the Dataflow service\nbelieves currently has the lease on the WorkItem, the report\nwill be dropped (with an error response).",
"type": "string"
@@ -4676,42 +4636,19 @@
"location": {
"description": "The location which contains the WorkItem's job.",
"type": "string"
+ },
+ "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"
+ }
}
},
"id": "ReportWorkItemStatusRequest",
"description": "Request to report the status of WorkItems.",
"type": "object"
},
- "StreamingConfigTask": {
- "description": "A task that carries configuration information for streaming computations.",
- "type": "object",
- "properties": {
- "windmillServiceEndpoint": {
- "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": {
- "type": "string"
- },
- "description": "Map from user step names to state families.",
- "type": "object"
- },
- "windmillServicePort": {
- "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",
- "type": "string"
- },
- "streamingComputationConfigs": {
- "description": "Set of computation configuration information.",
- "type": "array",
- "items": {
- "$ref": "StreamingComputationConfig"
- }
- }
- },
- "id": "StreamingConfigTask"
- },
"PipelineDescription": {
"properties": {
"originalPipelineTransform": {
@@ -4740,30 +4677,39 @@
"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"
},
- "Step": {
+ "StreamingConfigTask": {
"properties": {
- "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.",
+ "windmillServiceEndpoint": {
+ "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"
},
- "kind": {
- "description": "The kind of step in the Cloud Dataflow job.",
- "type": "string"
- },
- "properties": {
+ "userStepToStateFamilyNameMap": {
"additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
+ "type": "string"
},
- "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.",
+ "description": "Map from user step names to state families.",
"type": "object"
+ },
+ "windmillServicePort": {
+ "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",
+ "type": "string"
+ },
+ "streamingComputationConfigs": {
+ "description": "Set of computation configuration information.",
+ "type": "array",
+ "items": {
+ "$ref": "StreamingComputationConfig"
+ }
}
},
- "id": "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.",
+ "id": "StreamingConfigTask",
+ "description": "A task that carries configuration information for streaming computations.",
"type": "object"
},
"JobExecutionInfo": {
+ "description": "Additional information about how a Cloud Dataflow job will be executed that\nisn't contained in the submitted job.",
+ "type": "object",
"properties": {
"stages": {
"additionalProperties": {
@@ -4773,9 +4719,30 @@
"type": "object"
}
},
- "id": "JobExecutionInfo",
- "description": "Additional information about how a Cloud Dataflow job will be executed that\nisn't contained in the submitted job.",
- "type": "object"
+ "id": "JobExecutionInfo"
+ },
+ "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": {
+ "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.",
+ "type": "object"
+ },
+ "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": {
"properties": {
@@ -4789,8 +4756,6 @@
"type": "object"
},
"Disk": {
- "description": "Describes the data disk used by a workflow job.",
- "type": "object",
"properties": {
"sizeGb": {
"description": "Size of disk in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
@@ -4806,38 +4771,25 @@
"type": "string"
}
},
- "id": "Disk"
- },
- "ListJobMessagesResponse": {
- "description": "Response to a request to list job messages.",
- "type": "object",
- "properties": {
- "jobMessages": {
- "description": "Messages in ascending timestamp order.",
- "type": "array",
- "items": {
- "$ref": "JobMessage"
- }
- },
- "nextPageToken": {
- "description": "The token to obtain the next page of results if there are more.",
- "type": "string"
- },
- "autoscalingEvents": {
- "description": "Autoscaling events in ascending timestamp order.",
- "type": "array",
- "items": {
- "$ref": "AutoscalingEvent"
- }
- }
- },
- "id": "ListJobMessagesResponse"
+ "id": "Disk",
+ "description": "Describes the data disk used by a workflow job.",
+ "type": "object"
},
"CounterMetadata": {
"description": "CounterMetadata includes all static non-name non-value counter attributes.",
"type": "object",
"properties": {
"standardUnits": {
+ "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",
@@ -4849,17 +4801,7 @@
"TIMESTAMP_NSEC"
],
"description": "System defined Units, see above enum.",
- "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."
- ]
+ "type": "string"
},
"otherUnits": {
"description": "A string referring to the unit type.",
@@ -4898,10 +4840,39 @@
},
"id": "CounterMetadata"
},
+ "ListJobMessagesResponse": {
+ "properties": {
+ "jobMessages": {
+ "description": "Messages in ascending timestamp order.",
+ "type": "array",
+ "items": {
+ "$ref": "JobMessage"
+ }
+ },
+ "nextPageToken": {
+ "description": "The token to obtain the next page of results if there are more.",
+ "type": "string"
+ },
+ "autoscalingEvents": {
+ "description": "Autoscaling events in ascending timestamp order.",
+ "type": "array",
+ "items": {
+ "$ref": "AutoscalingEvent"
+ }
+ }
+ },
+ "id": "ListJobMessagesResponse",
+ "description": "Response to a request to list job messages.",
+ "type": "object"
+ },
"ApproximateReportedProgress": {
"description": "A progress measurement of a WorkItem by a worker.",
"type": "object",
"properties": {
+ "position": {
+ "$ref": "Position",
+ "description": "A Position within the work to represent a progress."
+ },
"fractionConsumed": {
"description": "Completion as fraction of the input consumed, from 0.0 (beginning, nothing\nconsumed), to 1.0 (end of the input, entire input consumed).",
"format": "double",
@@ -4914,29 +4885,10 @@
"remainingParallelism": {
"$ref": "ReportedParallelism",
"description": "Total amount of parallelism in the input of this task that remains,\n(i.e. can be delegated to this task and any new tasks via dynamic\nsplitting). Always at least 1 for non-finished work items and 0 for\nfinished.\n\n\"Amount of parallelism\" refers to how many non-empty parts of the input\ncan be read in parallel. This does not necessarily equal number\nof records. An input that can be read in parallel down to the\nindividual records is called \"perfectly splittable\".\nAn example of non-perfectly parallelizable input is a block-compressed\nfile format where a block of records has to be read as a whole,\nbut different blocks can be read in parallel.\n\nExamples:\n* If we are processing record #30 (starting at 1) out of 50 in a perfectly\n splittable 50-record input, this value should be 21 (20 remaining + 1\n current).\n* If we are reading through block 3 in a block-compressed file consisting\n of 5 blocks, this value should be 3 (since blocks 4 and 5 can be\n processed in parallel by new tasks via dynamic splitting and the current\n task remains processing block 3).\n* If we are reading through the last block in a block-compressed file,\n or reading or processing the last record in a perfectly splittable\n input, this value should be 1, because apart from the current task, no\n additional remainder can be split off."
- },
- "position": {
- "description": "A Position within the work to represent a progress.",
- "$ref": "Position"
}
},
"id": "ApproximateReportedProgress"
},
- "StateFamilyConfig": {
- "description": "State family configuration.",
- "type": "object",
- "properties": {
- "stateFamily": {
- "description": "The state family value.",
- "type": "string"
- },
- "isRead": {
- "description": "If true, this family corresponds to a read operation.",
- "type": "boolean"
- }
- },
- "id": "StateFamilyConfig"
- },
"IntegerList": {
"properties": {
"elements": {
@@ -4951,6 +4903,21 @@
"description": "A metric value representing a list of integers.",
"type": "object"
},
+ "StateFamilyConfig": {
+ "description": "State family configuration.",
+ "type": "object",
+ "properties": {
+ "isRead": {
+ "description": "If true, this family corresponds to a read operation.",
+ "type": "boolean"
+ },
+ "stateFamily": {
+ "description": "The state family value.",
+ "type": "string"
+ }
+ },
+ "id": "StateFamilyConfig"
+ },
"ResourceUtilizationReportResponse": {
"description": "Service-side response to WorkerMessage reporting resource utilization.",
"type": "object",
@@ -4958,23 +4925,7 @@
"id": "ResourceUtilizationReportResponse"
},
"SourceSplitResponse": {
- "description": "The response to a SourceSplitRequest.",
- "type": "object",
"properties": {
- "outcome": {
- "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.",
- "type": "string"
- },
"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",
@@ -4988,25 +4939,39 @@
"items": {
"$ref": "SourceSplitShard"
}
+ },
+ "outcome": {
+ "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.",
+ "type": "string"
}
},
- "id": "SourceSplitResponse"
+ "id": "SourceSplitResponse",
+ "description": "The response to a SourceSplitRequest.",
+ "type": "object"
},
"ParallelInstruction": {
- "description": "Describes a particular operation comprising a MapTask.",
- "type": "object",
"properties": {
- "write": {
- "$ref": "WriteInstruction",
- "description": "Additional information for Write instructions."
- },
"systemName": {
"description": "System-defined name of this operation.\nUnique across the workflow.",
"type": "string"
},
+ "write": {
+ "description": "Additional information for Write instructions.",
+ "$ref": "WriteInstruction"
+ },
"partialGroupByKey": {
- "description": "Additional information for PartialGroupByKey instructions.",
- "$ref": "PartialGroupByKeyInstruction"
+ "$ref": "PartialGroupByKeyInstruction",
+ "description": "Additional information for PartialGroupByKey instructions."
},
"outputs": {
"description": "Describes the outputs of the instruction.",
@@ -5019,14 +4984,14 @@
"description": "User-provided name of this operation.",
"type": "string"
},
- "parDo": {
- "description": "Additional information for ParDo instructions.",
- "$ref": "ParDoInstruction"
- },
"read": {
"description": "Additional information for Read instructions.",
"$ref": "ReadInstruction"
},
+ "parDo": {
+ "$ref": "ParDoInstruction",
+ "description": "Additional information for ParDo instructions."
+ },
"originalName": {
"description": "System-defined name for the operation in the original workflow graph.",
"type": "string"
@@ -5036,7 +5001,24 @@
"description": "Additional information for Flatten instructions."
}
},
- "id": "ParallelInstruction"
+ "id": "ParallelInstruction",
+ "description": "Describes a particular operation comprising a MapTask.",
+ "type": "object"
+ },
+ "Package": {
+ "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": {
+ "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.",
+ "type": "object"
},
"KeyRangeDataDiskAssignment": {
"properties": {
@@ -5057,26 +5039,49 @@
"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"
},
- "Package": {
+ "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.",
+ "type": "object",
"properties": {
- "name": {
- "description": "The name of the package.",
- "type": "string"
+ "input": {
+ "description": "The input.",
+ "$ref": "InstructionInput"
},
- "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"
+ "numOutputs": {
+ "description": "The number of outputs.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sideInputs": {
+ "description": "Zero or more side inputs.",
+ "type": "array",
+ "items": {
+ "$ref": "SideInputInfo"
+ }
+ },
+ "multiOutputInfos": {
+ "description": "Information about each of the outputs, if user_fn is a MultiDoFn.",
+ "type": "array",
+ "items": {
+ "$ref": "MultiOutputInfo"
+ }
+ },
+ "userFn": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The user function to invoke.",
+ "type": "object"
}
},
- "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.",
- "type": "object"
+ "id": "ParDoInstruction"
}
},
"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": "v1b3",
"baseUrl": "https://dataflow.googleapis.com/",
@@ -5100,10 +5105,5 @@
},
"kind": "discovery#restDescription",
"description": "Manages Google Cloud Dataflow projects on Google Cloud Platform.",
- "servicePath": "",
- "rootUrl": "https://dataflow.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "dataflow",
- "batchPath": "batch"
+ "servicePath": ""
}
diff --git a/dataproc/v1/dataproc-api.json b/dataproc/v1/dataproc-api.json
index 856ff55..2909f73 100644
--- a/dataproc/v1/dataproc-api.json
+++ b/dataproc/v1/dataproc-api.json
@@ -4,186 +4,56 @@
"ownerDomain": "google.com",
"name": "dataproc",
"batchPath": "batch",
- "revision": "20171212",
"documentationLink": "https://cloud.google.com/dataproc/",
"id": "dataproc:v1",
+ "revision": "20171212",
"fullyEncodeReservedExpansion": true,
"title": "Google Cloud Dataproc API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
"projects": {
"resources": {
"regions": {
"resources": {
- "jobs": {
+ "clusters": {
"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": {
- "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"
- }
- },
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submit",
- "path": "v1/projects/{projectId}/regions/{region}/jobs:submit",
- "id": "dataproc.projects.regions.jobs.submit"
- },
- "delete": {
- "path": "v1/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",
- "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": {
+ "description": "Lists all regions/{region}/clusters in a project.",
"response": {
- "$ref": "ListJobsResponse"
+ "$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 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 = *",
+ "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"
},
- "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.",
+ "description": "Optional. The standard List page token.",
"type": "string",
"location": "query"
},
"pageSize": {
- "description": "Optional. The number of results to return in each response.",
+ "description": "Optional. The standard List page size.",
"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",
- "path": "v1/projects/{projectId}/regions/{region}/jobs",
- "id": "dataproc.projects.regions.jobs.list",
- "description": "Lists regions/{region}/jobs in a project."
- },
- "cancel": {
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
- "id": "dataproc.projects.regions.jobs.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": {
- "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.",
+ "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"required": true,
"type": "string"
}
@@ -191,97 +61,10 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel"
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.list"
},
- "get": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "httpMethod": "GET",
- "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,
- "type": "string",
- "location": "path"
- },
- "jobId": {
- "description": "Required. The job ID.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "path": "v1/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": {
- "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"
- }
- },
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.patch"
- }
- }
- },
- "clusters": {
- "methods": {
"create": {
"path": "v1/projects/{projectId}/regions/{region}/clusters",
"id": "dataproc.projects.regions.clusters.create",
@@ -302,10 +85,10 @@
],
"parameters": {
"region": {
- "location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
@@ -317,6 +100,9 @@
"flatPath": "v1/projects/{projectId}/regions/{region}/clusters"
},
"get": {
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.get",
+ "description": "Gets the resource representation for a cluster in a project.",
"response": {
"$ref": "Cluster"
},
@@ -326,6 +112,431 @@
"clusterName"
],
"httpMethod": "GET",
+ "parameters": {
+ "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"
+ },
+ "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": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}"
+ },
+ "patch": {
+ "request": {
+ "$ref": "Cluster"
+ },
+ "description": "Updates a cluster in a project.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "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"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "location": "query",
+ "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"
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required. The cluster name.",
+ "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.patch",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}"
+ },
+ "diagnose": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "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"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "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.",
+ "request": {
+ "$ref": "DiagnoseClusterRequest"
+ }
+ },
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "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"
+ },
+ "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"
+ }
+ },
+ "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."
+ }
+ }
+ },
+ "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.",
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel",
+ "id": "dataproc.projects.regions.operations.cancel",
+ "path": "v1/{+name}:cancel"
+ },
+ "delete": {
+ "response": {
+ "$ref": "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/[^/]+/regions/[^/]+/operations/[^/]+$"
+ }
+ },
+ "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."
+ },
+ "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",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "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": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations",
+ "id": "dataproc.projects.regions.operations.list",
+ "path": "v1/{+name}"
+ },
+ "get": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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."
+ }
+ }
+ },
+ "jobs": {
+ "methods": {
+ "submit": {
+ "request": {
+ "$ref": "SubmitJobRequest"
+ },
+ "description": "Submits a job to a cluster.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "httpMethod": "POST",
+ "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"
+ }
+ },
+ "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"
+ },
+ "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",
+ "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,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "description": "Required. The job ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.delete"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameters": {
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs",
+ "id": "dataproc.projects.regions.jobs.list",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs",
+ "description": "Lists regions/{region}/jobs in a project."
+ },
+ "cancel": {
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -336,49 +547,50 @@
"required": true,
"type": "string"
},
- "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"
- }
- },
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.get",
- "description": "Gets the resource representation for a cluster in a project."
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "clusterName": {
- "description": "Required. The cluster name.",
+ "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"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",
+ "jobId": {
+ "location": "path",
+ "description": "Required. The job ID.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
+ "id": "dataproc.projects.regions.jobs.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"
+ }
+ },
+ "patch": {
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Updates a job in a project.",
+ "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"
},
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
+ "jobId": {
+ "description": "Required. The job ID.",
"required": true,
"type": "string",
"location": "path"
@@ -390,268 +602,56 @@
"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",
+ "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",
- "location": "query"
- }
- },
- "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.patch",
- "request": {
- "$ref": "Cluster"
- },
- "description": "Updates a cluster in a project."
- },
- "diagnose": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "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"
- },
- "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}/clusters/{clusterName}:diagnose",
- "id": "dataproc.projects.regions.clusters.diagnose",
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
- "request": {
- "$ref": "DiagnoseClusterRequest"
- },
- "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation."
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "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": {
- "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"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.delete",
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "description": "Deletes a cluster in a project."
- },
- "list": {
- "path": "v1/projects/{projectId}/regions/{region}/clusters",
- "id": "dataproc.projects.regions.clusters.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": {
- "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": {
- "location": "query",
- "description": "Optional. The standard List page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The standard List page size.",
- "format": "int32",
- "type": "integer"
- },
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters"
- }
- }
- },
- "operations": {
- "methods": {
- "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.",
- "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"
- },
- "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"
- ],
- "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "dataproc.projects.regions.operations.delete"
- },
- "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": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "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": "v1/projects/{projectsId}/regions/{regionsId}/operations",
- "path": "v1/{+name}",
- "id": "dataproc.projects.regions.operations.list"
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.patch"
},
"get": {
- "id": "dataproc.projects.regions.operations.get",
- "path": "v1/{+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.",
- "httpMethod": "GET",
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.get",
+ "description": "Gets the resource representation for a job in a project.",
"response": {
- "$ref": "Operation"
+ "$ref": "Job"
},
"parameterOrder": [
- "name"
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "name": {
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "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": "The name of the operation resource.",
+ "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"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}"
+ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}"
}
}
}
@@ -661,46 +661,37 @@
}
},
"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": {
- "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",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -712,17 +703,15 @@
"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"
+ "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"
},
@@ -737,390 +726,104 @@
"type": "boolean",
"default": "true"
},
- "bearer_token": {
+ "oauth_token": {
"location": "query",
- "description": "OAuth bearer token.",
+ "description": "OAuth 2.0 token for the current user.",
"type": "string"
},
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
+ "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"
}
},
"schemas": {
- "Status": {
- "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",
- "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"
- },
- "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": {
- "$ref": "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."
- },
- "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"
- }
- },
- "id": "InstanceGroupConfig"
- },
- "JobScheduling": {
- "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.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "JobScheduling",
- "description": "Job scheduling options.",
- "type": "object"
- },
- "NodeInitializationAction": {
- "properties": {
- "executableFile": {
- "description": "Required. Google Cloud Storage URI of executable file.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "NodeInitializationAction",
- "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
- "type": "object"
- },
- "ListJobsResponse": {
- "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",
- "description": "A list of jobs in a project.",
- "type": "object"
- },
- "CancelJobRequest": {
- "properties": {},
- "id": "CancelJobRequest",
- "description": "A request to cancel a job.",
- "type": "object"
- },
- "SparkSqlJob": {
- "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": {
- "$ref": "QueryList",
- "description": "A list of queries."
- },
- "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",
- "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.",
- "type": "object"
- },
- "Cluster": {
- "description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.",
+ "Job": {
+ "description": "A Cloud Dataproc job resource.",
"type": "object",
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
- "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.",
+ "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"
},
- "metrics": {
- "$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."
+ "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 cluster status.",
+ "description": "Output-only. The previous job status.",
"type": "array",
"items": {
- "$ref": "ClusterStatus"
+ "$ref": "JobStatus"
}
},
- "config": {
- "$ref": "ClusterConfig",
- "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated."
+ "sparkSqlJob": {
+ "description": "Job is a SparkSql job.",
+ "$ref": "SparkSqlJob"
},
- "clusterName": {
- "description": "Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.",
- "type": "string"
+ "sparkJob": {
+ "description": "Job is a Spark job.",
+ "$ref": "SparkJob"
},
- "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"
- },
- "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.",
+ "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": "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"
- },
- "SoftwareConfig": {
- "description": "Specifies the selection and config of software inside the cluster.",
- "type": "object",
- "properties": {
- "properties": {
- "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"
- },
- "ClusterStatus": {
- "description": "The status of a cluster and its instances.",
- "type": "object",
- "properties": {
- "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",
- "RUNNING",
- "ERROR",
- "DELETING",
- "UPDATING"
- ],
- "description": "Output-only. The cluster's state.",
- "type": "string"
- },
- "stateStartTime": {
- "description": "Output-only. Time when this state was entered.",
- "format": "google-datetime",
- "type": "string"
- },
- "substate": {
- "enum": [
- "UNSPECIFIED",
- "UNHEALTHY",
- "STALE_STATUS"
- ],
- "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.",
- "The agent-reported status is out of date (may occur if Cloud Dataproc loses communication with Agent).Applies to RUNNING state."
- ]
- },
- "detail": {
- "description": "Output-only. Optional details of cluster's state.",
- "type": "string"
- }
- },
- "id": "ClusterStatus"
- },
- "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"
- },
- "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"
+ "$ref": "YarnApplication"
}
},
- "scriptVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).",
- "type": "object"
+ "pysparkJob": {
+ "description": "Job is a Pyspark job.",
+ "$ref": "PySparkJob"
},
- "loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
+ "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"
},
- "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"
- },
- "ListClustersResponse": {
- "properties": {
- "clusters": {
- "description": "Output-only. The clusters in the project.",
- "type": "array",
- "items": {
- "$ref": "Cluster"
- }
+ "hadoopJob": {
+ "description": "Job is a Hadoop job.",
+ "$ref": "HadoopJob"
},
- "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 ListClustersRequest.",
+ "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."
+ },
+ "pigJob": {
+ "$ref": "PigJob",
+ "description": "Job is a Pig job."
+ },
+ "hiveJob": {
+ "$ref": "HiveJob",
+ "description": "Job is a Hive job."
}
},
- "id": "ListClustersResponse",
- "description": "The list of all clusters in a project.",
- "type": "object"
+ "id": "Job"
},
"SparkJob": {
"description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.",
@@ -1176,99 +879,9 @@
},
"id": "SparkJob"
},
- "Job": {
- "properties": {
- "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"
- },
- "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"
- },
- "placement": {
- "description": "Required. Job information, including how, when, and where to run the job.",
- "$ref": "JobPlacement"
- },
- "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."
- },
- "pigJob": {
- "description": "Job is a Pig job.",
- "$ref": "PigJob"
- },
- "hiveJob": {
- "$ref": "HiveJob",
- "description": "Job is a Hive job."
- },
- "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",
- "description": "A Cloud Dataproc job resource.",
- "type": "object"
- },
"JobStatus": {
- "description": "Cloud Dataproc job status.",
- "type": "object",
"properties": {
"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": [
@@ -1282,6 +895,18 @@
"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": {
@@ -1294,6 +919,12 @@
"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",
@@ -1301,18 +932,16 @@
"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."
- ]
+ "type": "string"
}
},
- "id": "JobStatus"
+ "id": "JobStatus",
+ "description": "Cloud Dataproc job status.",
+ "type": "object"
},
"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.",
@@ -1323,21 +952,18 @@
"type": "string"
}
},
- "id": "ManagedGroupConfig",
- "description": "Specifies the resources used to actively manage an instance group.",
- "type": "object"
+ "id": "ManagedGroupConfig"
},
"ClusterOperationStatus": {
"description": "The status of the operation.",
"type": "object",
"properties": {
+ "stateStartTime": {
+ "description": "Output-only. The time this state was entered.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"state": {
- "enum": [
- "UNKNOWN",
- "PENDING",
- "RUNNING",
- "DONE"
- ],
"description": "Output-only. A message containing the operation state.",
"type": "string",
"enumDescriptions": [
@@ -1345,6 +971,12 @@
"The operation has been created.",
"The operation is running.",
"The operation is done; either cancelled or completed."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "PENDING",
+ "RUNNING",
+ "DONE"
]
},
"details": {
@@ -1354,32 +986,12 @@
"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": {
"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": {
- "description": "Optional. The runtime log config for job execution.",
- "$ref": "LoggingConfig"
- },
"properties": {
"additionalProperties": {
"type": "string"
@@ -1411,6 +1023,21 @@
"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."
}
},
"id": "HadoopJob",
@@ -1478,14 +1105,12 @@
"id": "YarnApplication"
},
"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": {
"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.",
@@ -1498,27 +1123,14 @@
"type": "integer"
}
},
- "id": "DiskConfig"
+ "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": {
- "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"
@@ -1544,6 +1156,21 @@
"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"
}
},
"id": "ClusterOperationMetadata"
@@ -1552,13 +1179,6 @@
"description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
"type": "object",
"properties": {
- "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"
- },
"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"
@@ -1572,11 +1192,11 @@
"description": "A list of queries."
},
"scriptVariables": {
+ "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
- "type": "object"
+ }
},
"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.",
@@ -1584,34 +1204,52 @@
"items": {
"type": "string"
}
+ },
+ "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"
}
},
"id": "HiveJob"
},
"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"
},
"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",
- "description": "The location of diagnostic output.",
- "type": "object"
+ "id": "DiagnoseClusterResults"
},
"ClusterConfig": {
"description": "The cluster config.",
"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": {
- "$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.",
@@ -1628,36 +1266,12 @@
"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 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"
}
},
"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"
@@ -1696,12 +1310,44 @@
"items": {
"type": "string"
}
+ },
+ "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."
}
},
- "id": "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"
},
"GceClusterConfig": {
"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"
+ },
+ "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"
+ },
+ "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"
+ },
"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",
@@ -1723,35 +1369,37 @@
"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"
}
},
"id": "GceClusterConfig",
"description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
"type": "object"
},
- "AcceleratorConfig": {
- "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
+ "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": {
+ "hdfsMetrics": {
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ },
+ "description": "The HDFS metrics.",
+ "type": "object"
+ },
+ "yarnMetrics": {
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ },
+ "description": "The YARN metrics.",
+ "type": "object"
+ }
+ },
+ "id": "ClusterMetrics"
+ },
+ "AcceleratorConfig": {
+ "properties": {
"acceleratorCount": {
"description": "The number of the accelerator cards of this type exposed to this instance.",
"format": "int32",
@@ -1762,34 +1410,11 @@
"type": "string"
}
},
- "id": "AcceleratorConfig"
- },
- "ClusterMetrics": {
- "properties": {
- "yarnMetrics": {
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- },
- "description": "The YARN metrics.",
- "type": "object"
- },
- "hdfsMetrics": {
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- },
- "description": "The HDFS metrics.",
- "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.",
+ "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"
},
"LoggingConfig": {
- "description": "The runtime logging config of the job.",
- "type": "object",
"properties": {
"driverLogLevels": {
"additionalProperties": {
@@ -1810,10 +1435,30 @@
"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.",
+ "type": "object",
"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.",
@@ -1825,29 +1470,13 @@
"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": {
- "$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"
}
},
- "id": "Operation",
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object"
+ "id": "Operation"
},
"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.",
@@ -1858,9 +1487,7 @@
"type": "string"
}
},
- "id": "JobReference",
- "description": "Encapsulates the full scoping used to reference a job.",
- "type": "object"
+ "id": "JobReference"
},
"SubmitJobRequest": {
"description": "A request to submit a job.",
@@ -1872,13 +1499,386 @@
}
},
"id": "SubmitJobRequest"
+ },
+ "Status": {
+ "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",
+ "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"
+ },
+ "JobScheduling": {
+ "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.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "JobScheduling",
+ "description": "Job scheduling options.",
+ "type": "object"
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "InstanceGroupConfig"
+ },
+ "ListJobsResponse": {
+ "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",
+ "description": "A list of jobs in a project.",
+ "type": "object"
+ },
+ "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": {
+ "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": {
+ "queryList": {
+ "description": "A list of queries.",
+ "$ref": "QueryList"
+ },
+ "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."
+ },
+ "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"
+ }
+ },
+ "id": "SparkSqlJob"
+ },
+ "Cluster": {
+ "description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "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"
+ },
+ "metrics": {
+ "$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.",
+ "type": "array",
+ "items": {
+ "$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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "SoftwareConfig": {
+ "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).",
+ "type": "string"
+ },
+ "properties": {
+ "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"
+ }
+ },
+ "id": "SoftwareConfig",
+ "description": "Specifies the selection and config of software inside the cluster.",
+ "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": {
+ "properties": {
+ "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",
+ "RUNNING",
+ "ERROR",
+ "DELETING",
+ "UPDATING"
+ ],
+ "description": "Output-only. The cluster's state.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "ClusterStatus",
+ "description": "The status of a cluster and its instances.",
+ "type": "object"
+ },
+ "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"
+ },
+ "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": {
+ "description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).",
+ "type": "object",
+ "additionalProperties": {
+ "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"
+ },
+ "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 ListClustersRequest.",
+ "type": "string"
+ }
+ },
+ "id": "ListClustersResponse"
}
},
- "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",
"version": "v1",
"baseUrl": "https://dataproc.googleapis.com/",
"auth": {
diff --git a/dataproc/v1beta2/dataproc-api.json b/dataproc/v1beta2/dataproc-api.json
index 9807024..ec1bf88 100644
--- a/dataproc/v1beta2/dataproc-api.json
+++ b/dataproc/v1beta2/dataproc-api.json
@@ -3,356 +3,106 @@
"resources": {
"projects": {
"resources": {
- "regions": {
+ "locations": {
"resources": {
- "clusters": {
+ "workflowTemplates": {
"methods": {
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "region": {
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "updateMask": {
- "location": "query",
- "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"
- },
- "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}",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.patch",
- "request": {
- "$ref": "Cluster"
- },
- "description": "Updates a cluster in a project."
- },
- "get": {
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.get",
- "description": "Gets the resource representation for a cluster in a project.",
- "response": {
- "$ref": "Cluster"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "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"
- ]
- },
- "testIamPermissions": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "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",
- "id": "dataproc.projects.regions.clusters.testIamPermissions",
- "path": "v1beta2/{+resource}: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": {
- "description": "Deletes a cluster in a project.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
"httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
"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"
- },
- "clusterName": {
- "description": "Required. The cluster name.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterUuid": {
- "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",
- "location": "query"
- },
- "projectId": {
- "description": "Required. The ID of the Google Cloud Platform project that 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.delete"
- },
- "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": {
- "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"
- },
- "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"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose"
- },
- "list": {
- "description": "Lists all regions/{region}/clusters in a project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "response": {
- "$ref": "ListClustersResponse"
- },
- "parameters": {
- "region": {
- "location": "path",
- "description": "Required. The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- },
- "filter": {
- "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",
- "location": "query"
- },
- "pageToken": {
+ "version": {
"location": "query",
- "description": "Optional. The standard List page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The standard List page size.",
+ "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"
},
- "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"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters",
- "id": "dataproc.projects.regions.clusters.list",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters"
- },
- "create": {
- "request": {
- "$ref": "Cluster"
- },
- "description": "Creates a cluster in a project.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"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.",
+ "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/{projectId}/regions/{region}/clusters",
- "path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
- "id": "dataproc.projects.regions.clusters.create"
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
+ "id": "dataproc.projects.locations.workflowTemplates.delete",
+ "path": "v1beta2/{+name}",
+ "description": "Deletes a workflow template. It does not cancel in-progress workflows."
},
- "setIamPolicy": {
+ "list": {
+ "description": "Lists workflows that match the specified filter in the request.",
"response": {
- "$ref": "Policy"
+ "$ref": "ListWorkflowTemplatesResponse"
},
"parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "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",
- "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:setIamPolicy",
- "path": "v1beta2/{+resource}:setIamPolicy",
- "id": "dataproc.projects.regions.clusters.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any existing policy."
- },
- "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.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
+ "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": {
+ "description": "Optional. The maximum number of results to return in each response.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "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/[^/]+/locations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
+ "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",
- "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:getIamPolicy",
- "path": "v1beta2/{+resource}:getIamPolicy",
- "id": "dataproc.projects.regions.clusters.getIamPolicy"
- }
- }
- },
- "workflowTemplates": {
- "methods": {
- "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.",
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates",
+ "path": "v1beta2/{+parent}/workflowTemplates",
+ "id": "dataproc.projects.locations.workflowTemplates.create",
+ "description": "Creates new workflow template.",
"request": {
- "$ref": "InstantiateWorkflowTemplateRequest"
- },
+ "$ref": "WorkflowTemplate"
+ }
+ },
+ "instantiate": {
"response": {
"$ref": "Operation"
},
@@ -368,17 +118,19 @@
"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/[^/]+$",
+ "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"location": "path"
}
},
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
"path": "v1beta2/{+name}:instantiate",
- "id": "dataproc.projects.regions.workflowTemplates.instantiate"
+ "id": "dataproc.projects.locations.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"
+ }
},
"get": {
- "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"
@@ -395,19 +147,662 @@
"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/[^/]+$",
+ "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"
+ "type": "integer",
+ "location": "query"
}
},
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}"
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
+ "path": "v1beta2/{+name}",
+ "id": "dataproc.projects.locations.workflowTemplates.get"
},
"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/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
+ "id": "dataproc.projects.locations.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."
+ }
+ }
+ }
+ }
+ },
+ "regions": {
+ "resources": {
+ "jobs": {
+ "methods": {
+ "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": {
+ "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",
+ "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}"
+ },
+ "list": {
+ "id": "dataproc.projects.regions.jobs.list",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs",
+ "description": "Lists regions/{region}/jobs in a project.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "parameters": {
+ "region": {
+ "location": "path",
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs"
+ },
+ "cancel": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "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,
+ "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",
+ "id": "dataproc.projects.regions.jobs.cancel",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}: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."
+ },
+ "get": {
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "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"
+ },
+ "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.get",
+ "description": "Gets the resource representation for a job in a project."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "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 \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"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.patch",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Updates a job in a project."
+ }
+ }
+ },
+ "clusters": {
+ "methods": {
+ "create": {
+ "id": "dataproc.projects.regions.clusters.create",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
+ "request": {
+ "$ref": "Cluster"
+ },
+ "description": "Creates a cluster in a project.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters"
+ },
+ "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": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
+ "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"
+ }
+ },
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.get"
+ },
+ "patch": {
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.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": {
+ "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"
+ },
+ "region": {
+ "description": "Required. The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "location": "query",
+ "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"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}"
+ },
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "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",
+ "id": "dataproc.projects.regions.clusters.testIamPermissions",
+ "path": "v1beta2/{+resource}:testIamPermissions"
+ },
+ "diagnose": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
+ "id": "dataproc.projects.regions.clusters.diagnose",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
+ "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
+ "request": {
+ "$ref": "DiagnoseClusterRequest"
+ }
+ },
+ "delete": {
+ "description": "Deletes a cluster in a project.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "clusterName": {
+ "description": "Required. The cluster name.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.delete"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "parameters": {
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.list",
+ "path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
+ "description": "Lists all regions/{region}/clusters in a project."
+ }
+ }
+ },
+ "workflowTemplates": {
+ "methods": {
+ "update": {
"response": {
"$ref": "WorkflowTemplate"
},
@@ -415,9 +810,6 @@
"name"
],
"httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"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}",
@@ -427,49 +819,49 @@
"location": "path"
}
},
+ "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",
- "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.",
"request": {
"$ref": "WorkflowTemplate"
- }
+ },
+ "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version."
},
"delete": {
+ "path": "v1beta2/{+name}",
+ "id": "dataproc.projects.regions.workflowTemplates.delete",
"description": "Deletes a workflow template. It does not cancel in-progress workflows.",
- "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "DELETE",
+ "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": {
"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/[^/]+/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"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
- "id": "dataproc.projects.regions.workflowTemplates.delete",
- "path": "v1beta2/{+name}"
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}"
},
"list": {
- "path": "v1beta2/{+parent}/workflowTemplates",
- "id": "dataproc.projects.regions.workflowTemplates.list",
- "description": "Lists workflows that match the specified filter in the request.",
"response": {
"$ref": "ListWorkflowTemplatesResponse"
},
@@ -478,6 +870,11 @@
],
"httpMethod": "GET",
"parameters": {
+ "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 maximum number of results to return in each response.",
@@ -485,28 +882,22 @@
"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",
- "pattern": "^projects/[^/]+/regions/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "Optional. The page token, returned by a previous call, to request the next page of results.",
- "type": "string",
- "location": "query"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates"
+ "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."
},
"create": {
- "description": "Creates new workflow template.",
- "request": {
- "$ref": "WorkflowTemplate"
- },
"response": {
"$ref": "WorkflowTemplate"
},
@@ -514,28 +905,90 @@
"parent"
],
"httpMethod": "POST",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates",
+ "path": "v1beta2/{+parent}/workflowTemplates",
+ "id": "dataproc.projects.regions.workflowTemplates.create",
+ "request": {
+ "$ref": "WorkflowTemplate"
+ },
+ "description": "Creates new workflow template."
+ },
+ "instantiate": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"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}",
+ "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",
- "pattern": "^projects/[^/]+/regions/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates",
- "path": "v1beta2/{+parent}/workflowTemplates",
- "id": "dataproc.projects.regions.workflowTemplates.create"
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
+ "path": "v1beta2/{+name}:instantiate",
+ "id": "dataproc.projects.regions.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"
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "WorkflowTemplate"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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 retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current 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.get",
+ "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter."
}
}
},
"operations": {
"methods": {
"cancel": {
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel",
"id": "dataproc.projects.regions.operations.cancel",
"path": "v1beta2/{+name}: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.",
@@ -548,18 +1001,21 @@
],
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path",
"description": "The name of the operation resource to be cancelled.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}: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"
@@ -573,31 +1029,30 @@
],
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
"location": "path",
"description": "The name of the operation resource to be deleted.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$"
+ "type": "string"
}
},
- "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
- "path": "v1beta2/{+name}",
- "id": "dataproc.projects.regions.operations.delete"
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}"
},
"list": {
- "httpMethod": "GET",
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
"name": {
"description": "The name of the operation's parent resource.",
"required": true,
@@ -615,18 +1070,16 @@
"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",
- "id": "dataproc.projects.regions.operations.list",
- "path": "v1beta2/{+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."
+ "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/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"
},
@@ -648,461 +1101,8 @@
],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
"path": "v1beta2/{+name}",
- "id": "dataproc.projects.regions.operations.get"
- }
- }
- },
- "jobs": {
- "methods": {
- "cancel": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "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 job belongs to.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "description": "Required. The job ID.",
- "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"
- }
- },
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
- "id": "dataproc.projects.regions.jobs.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"
- }
- },
- "patch": {
- "request": {
- "$ref": "Job"
- },
- "description": "Updates a job in a project.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "response": {
- "$ref": "Job"
- },
- "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"
- },
- "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}",
- "id": "dataproc.projects.regions.jobs.patch",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}"
- },
- "get": {
- "id": "dataproc.projects.regions.jobs.get",
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "description": "Gets the resource representation for a job in a project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "response": {
- "$ref": "Job"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}"
- },
- "submit": {
- "path": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
- "id": "dataproc.projects.regions.jobs.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"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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": {
- "description": "Required. The job ID.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.delete",
- "path": "v1beta2/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."
- },
- "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": {
- "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": {
- "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": {
- "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": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- }
- }
- }
- },
- "locations": {
- "resources": {
- "workflowTemplates": {
- "methods": {
- "instantiate": {
- "path": "v1beta2/{+name}:instantiate",
- "id": "dataproc.projects.locations.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": {
- "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"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:instantiate"
- },
- "get": {
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
- "id": "dataproc.projects.locations.workflowTemplates.get",
- "path": "v1beta2/{+name}",
- "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.",
- "httpMethod": "GET",
- "response": {
- "$ref": "WorkflowTemplate"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "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"
- },
- "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"
- ]
- },
- "update": {
- "response": {
- "$ref": "WorkflowTemplate"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "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/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
- "location": "path"
- }
- },
- "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",
- "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": {
- "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": {
- "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"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
- "path": "v1beta2/{+name}",
- "id": "dataproc.projects.locations.workflowTemplates.delete"
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListWorkflowTemplatesResponse"
- },
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return in each response.",
- "format": "int32",
- "type": "integer"
- },
- "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/[^/]+$"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. The page token, returned by a previous call, to request the next page of results.",
- "type": "string"
- }
- },
- "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": {
- "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",
- "path": "v1beta2/{+parent}/workflowTemplates",
- "id": "dataproc.projects.locations.workflowTemplates.create",
- "request": {
- "$ref": "WorkflowTemplate"
- },
- "description": "Creates new workflow template."
+ "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."
}
}
}
@@ -1112,41 +1112,7 @@
}
},
"parameters": {
- "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": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -1154,12 +1120,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": {
"location": "query",
@@ -1167,9 +1139,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",
@@ -1177,777 +1149,143 @@
"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": {
+ "upload_protocol": {
"location": "query",
- "description": "OAuth 2.0 token for the current user.",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"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"
+ },
+ "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"
}
},
"version": "v1beta2",
"baseUrl": "https://dataproc.googleapis.com/",
- "servicePath": "",
"kind": "discovery#restDescription",
"description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
+ "servicePath": "",
"basePath": "",
+ "id": "dataproc:v1beta2",
"revision": "20171212",
"documentationLink": "https://cloud.google.com/dataproc/",
- "id": "dataproc:v1beta2",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "ClusterOperationMetadata": {
- "description": "Metadata describing the operation.",
- "type": "object",
+ "YarnApplication": {
"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"
- }
- },
- "clusterName": {
- "description": "Output-only. Name of the cluster for the operation.",
- "type": "string"
- },
- "clusterUuid": {
- "description": "Output-only. Cluster UUID 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"
- },
- "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": {
- "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": {
- "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"
- },
- "bindings": {
- "description": "Associates a list of members to a role. 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 network 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 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"
- },
- "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": {
- "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.",
- "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"
- },
- "Status": {
- "properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any 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"
- }
- }
- }
- },
- "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"
- },
- "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": {
- "managedGroupConfig": {
- "$ref": "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."
- },
- "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"
- },
- "diskConfig": {
- "description": "Optional. Disk option config settings.",
- "$ref": "DiskConfig"
- }
- },
- "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": {
- "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"
- },
- "CancelJobRequest": {
- "properties": {},
- "id": "CancelJobRequest",
- "description": "A request to cancel a job.",
- "type": "object"
- },
- "SparkSqlJob": {
- "properties": {
- "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": {
- "$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 Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
- "type": "object"
- }
- },
- "id": "SparkSqlJob",
- "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.",
- "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"
- },
- "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": {
- "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"
- },
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains the Pig queries.",
- "type": "string"
- },
- "queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
- },
- "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": {
- "$ref": "LoggingConfig",
- "description": "Optional. The runtime log config for job execution."
- }
- },
- "id": "PigJob"
- },
- "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": {
- "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.",
- "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"
- ]
- },
- "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"
- },
- "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": {
- "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",
- "additionalProperties": {
- "type": "string"
- }
- },
- "createTime": {
- "description": "Output only. The time template was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "placement": {
- "description": "Required. WorkflowTemplate scheduling information.",
- "$ref": "WorkflowTemplatePlacement"
- },
- "updateTime": {
- "description": "Output only. The time template was last updated.",
- "format": "google-datetime",
+ "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"
+ ],
+ "description": "Required. The application state.",
"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}",
+ "description": "Required. The application name.",
"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.",
+ "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": "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": {
- "properties": {
- "hadoopJob": {
- "description": "Job is a Hadoop job.",
- "$ref": "HadoopJob"
- },
- "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": {
- "$ref": "HiveJob",
- "description": "Job is a Hive job."
- },
- "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": {
- "description": "Job is a SparkSql job.",
- "$ref": "SparkSqlJob"
- },
- "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": {
- "$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"
- }
- },
- "id": "Job",
- "description": "A Cloud Dataproc job resource.",
+ "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"
},
- "ManagedGroupConfig": {
- "description": "Specifies the resources used to actively manage an instance group.",
- "type": "object",
+ "QueryList": {
"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"
- },
- "LifecycleConfig": {
- "description": "Specifies the cluster auto delete related schedule configuration.",
- "type": "object",
- "properties": {
- "autoDeleteTtl": {
- "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"
- },
- "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",
- "type": "string"
- }
- },
- "id": "LifecycleConfig"
- },
- "ManagedCluster": {
- "description": "Cluster that is managed by the workflow.",
- "type": "object",
- "properties": {
- "config": {
- "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.",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
+ "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"
- },
- "description": "Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.",
- "type": "object"
+ }
}
},
- "id": "ManagedCluster"
- },
- "ClusterOperationStatus": {
- "description": "The status of the operation.",
- "type": "object",
- "properties": {
- "state": {
- "description": "Output-only. A message containing the operation state.",
- "type": "string",
- "enumDescriptions": [
- "Unused.",
- "The operation has been created.",
- "The operation is running.",
- "The operation is done; either cancelled or completed."
- ],
- "enum": [
- "UNKNOWN",
- "PENDING",
- "RUNNING",
- "DONE"
- ]
- },
- "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"
+ "id": "QueryList",
+ "description": "A list of queries to run on a cluster.",
+ "type": "object"
},
"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": {
+ "description": "Optional. The runtime log config for job execution.",
+ "$ref": "LoggingConfig"
+ },
"properties": {
"additionalProperties": {
"type": "string"
@@ -1983,86 +1321,15 @@
"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."
}
},
"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": {
- "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": {
- "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"
- },
"SetIamPolicyRequest": {
"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",
@@ -2070,28 +1337,26 @@
"type": "object"
},
"HiveJob": {
- "description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
- "type": "object",
"properties": {
+ "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"
+ },
"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"
},
- "queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
- },
- "scriptVariables": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
- "type": "object"
- },
"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",
@@ -2099,28 +1364,16 @@
"type": "string"
}
},
- "properties": {
+ "scriptVariables": {
"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.",
+ "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
"type": "object"
}
},
- "id": "HiveJob"
- },
- "WorkflowGraph": {
- "properties": {
- "nodes": {
- "description": "Output only. The workflow nodes.",
- "type": "array",
- "items": {
- "$ref": "WorkflowNode"
- }
- }
- },
- "id": "WorkflowGraph",
- "description": "The workflow graph.",
+ "id": "HiveJob",
+ "description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
"type": "object"
},
"DiagnoseClusterResults": {
@@ -2134,10 +1387,32 @@
"description": "The location of diagnostic output.",
"type": "object"
},
+ "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",
@@ -2154,31 +1429,21 @@
"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": {
- "$ref": "GceClusterConfig",
- "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster."
+ "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster.",
+ "$ref": "GceClusterConfig"
},
"softwareConfig": {
- "description": "Optional. The config settings for software inside the cluster.",
- "$ref": "SoftwareConfig"
- },
- "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"
+ "$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.",
@@ -2231,30 +1496,23 @@
}
}
},
- "id": "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"
},
- "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",
+ "TestIamPermissionsRequest": {
"properties": {
- "yarnMetrics": {
- "description": "The YARN metrics.",
- "type": "object",
- "additionalProperties": {
- "format": "int64",
+ "permissions": {
+ "description": "The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).",
+ "type": "array",
+ "items": {
"type": "string"
}
- },
- "hdfsMetrics": {
- "additionalProperties": {
- "format": "int64",
- "type": "string"
- },
- "description": "The HDFS metrics.",
- "type": "object"
}
},
- "id": "ClusterMetrics"
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for TestIamPermissions method.",
+ "type": "object"
},
"AcceleratorConfig": {
"description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
@@ -2272,18 +1530,27 @@
},
"id": "AcceleratorConfig"
},
- "TestIamPermissionsRequest": {
+ "ClusterMetrics": {
"properties": {
- "permissions": {
- "description": "The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
+ "yarnMetrics": {
+ "additionalProperties": {
+ "format": "int64",
"type": "string"
- }
+ },
+ "description": "The YARN metrics.",
+ "type": "object"
+ },
+ "hdfsMetrics": {
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ },
+ "description": "The HDFS metrics.",
+ "type": "object"
}
},
- "id": "TestIamPermissionsRequest",
- "description": "Request message for TestIamPermissions method.",
+ "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"
},
"LoggingConfig": {
@@ -2314,25 +1581,6 @@
"OrderedJob": {
"type": "object",
"properties": {
- "labels": {
- "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"
- },
- "sparkSqlJob": {
- "$ref": "SparkSqlJob",
- "description": "Job is a SparkSql job."
- },
- "sparkJob": {
- "$ref": "SparkJob",
- "description": "Job is a Spark job."
- },
- "pysparkJob": {
- "description": "Job is a Pyspark job.",
- "$ref": "PySparkJob"
- },
"scheduling": {
"description": "Optional. Job scheduling configuration.",
"$ref": "JobScheduling"
@@ -2349,16 +1597,35 @@
"$ref": "HadoopJob",
"description": "Job is a Hadoop job."
},
- "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.",
"type": "array",
"items": {
"type": "string"
}
+ },
+ "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 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": {
+ "$ref": "SparkJob",
+ "description": "Job is a Spark job."
+ },
+ "sparkSqlJob": {
+ "description": "Job is a SparkSql job.",
+ "$ref": "SparkSqlJob"
+ },
+ "pysparkJob": {
+ "description": "Job is a Pyspark job.",
+ "$ref": "PySparkJob"
}
},
"id": "OrderedJob"
@@ -2367,13 +1634,6 @@
"description": "The workflow node.",
"type": "object",
"properties": {
- "prerequisiteStepIds": {
- "description": "Output only. Node's prerequisite nodes.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"state": {
"enum": [
"NODE_STATUS_UNSPECIFIED",
@@ -2405,6 +1665,13 @@
"jobId": {
"description": "Output only. The job id; populated after the node enters RUNNING state.",
"type": "string"
+ },
+ "prerequisiteStepIds": {
+ "description": "Output only. Node's prerequisite nodes.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"id": "WorkflowNode"
@@ -2426,15 +1693,15 @@
"type": "object"
},
"SubmitJobRequest": {
- "description": "A request to submit a job.",
- "type": "object",
"properties": {
"job": {
"description": "Required. The job resource.",
"$ref": "Job"
}
},
- "id": "SubmitJobRequest"
+ "id": "SubmitJobRequest",
+ "description": "A request to submit a job.",
+ "type": "object"
},
"JobScheduling": {
"description": "Job scheduling options.",
@@ -2460,12 +1727,12 @@
"type": "object"
},
"metrics": {
- "$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."
+ "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"
},
"status": {
- "description": "Output-only. Cluster status.",
- "$ref": "ClusterStatus"
+ "$ref": "ClusterStatus",
+ "description": "Output-only. Cluster status."
},
"statusHistory": {
"description": "Output-only. The previous cluster status.",
@@ -2475,8 +1742,8 @@
}
},
"config": {
- "$ref": "ClusterConfig",
- "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated."
+ "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.",
+ "$ref": "ClusterConfig"
},
"clusterName": {
"description": "Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.",
@@ -2494,8 +1761,6 @@
"id": "Cluster"
},
"TestIamPermissionsResponse": {
- "description": "Response message for TestIamPermissions method.",
- "type": "object",
"properties": {
"permissions": {
"description": "A subset of TestPermissionsRequest.permissions that the caller is allowed.",
@@ -2505,7 +1770,9 @@
}
}
},
- "id": "TestIamPermissionsResponse"
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for TestIamPermissions method.",
+ "type": "object"
},
"SoftwareConfig": {
"description": "Specifies the selection and config of software inside the cluster.",
@@ -2529,16 +1796,16 @@
"description": "A selector that chooses target cluster for jobs based on metadata.",
"type": "object",
"properties": {
- "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"
+ },
+ "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"
}
},
"id": "ClusterSelector"
@@ -2546,12 +1813,12 @@
"WorkflowTemplatePlacement": {
"properties": {
"managedCluster": {
- "$ref": "ManagedCluster",
- "description": "Optional. A cluster that is managed by the workflow."
+ "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."
+ "description": "Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted.",
+ "$ref": "ClusterSelector"
}
},
"id": "WorkflowTemplatePlacement",
@@ -2562,7 +1829,30 @@
"description": "A Cloud Dataproc workflow template resource.",
"type": "object",
"properties": {
+ "graph": {
+ "description": "Output only. The workflow graph.",
+ "$ref": "WorkflowGraph"
+ },
+ "version": {
+ "description": "Output only. The version of template at the time of workflow instantiation.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "template": {
+ "description": "Output only. The \"resource name\" of the template.",
+ "type": "string"
+ },
+ "deleteCluster": {
+ "description": "Output only. The delete cluster operation metadata.",
+ "$ref": "ClusterOperation"
+ },
"state": {
+ "enum": [
+ "UNKNOWN",
+ "PENDING",
+ "RUNNING",
+ "DONE"
+ ],
"description": "Output only. The workflow state.",
"type": "string",
"enumDescriptions": [
@@ -2570,12 +1860,6 @@
"The operation has been created.",
"The operation is running.",
"The operation is done; either cancelled or completed."
- ],
- "enum": [
- "UNKNOWN",
- "PENDING",
- "RUNNING",
- "DONE"
]
},
"clusterName": {
@@ -2585,29 +1869,11 @@
"createCluster": {
"$ref": "ClusterOperation",
"description": "Output only. The create cluster operation metadata."
- },
- "version": {
- "description": "Output only. The version of template at the time of workflow instantiation.",
- "format": "int32",
- "type": "integer"
- },
- "graph": {
- "description": "Output only. The workflow graph.",
- "$ref": "WorkflowGraph"
- },
- "template": {
- "description": "Output only. The \"resource name\" of the template.",
- "type": "string"
- },
- "deleteCluster": {
- "description": "Output only. The delete cluster operation metadata.",
- "$ref": "ClusterOperation"
}
},
"id": "WorkflowMetadata"
},
"ClusterOperation": {
- "type": "object",
"properties": {
"operationId": {
"description": "Output only. The id of the cluster operation.",
@@ -2622,12 +1888,28 @@
"type": "boolean"
}
},
- "id": "ClusterOperation"
+ "id": "ClusterOperation",
+ "type": "object"
},
"SparkJob": {
"description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.",
"type": "object",
"properties": {
+ "mainJarFileUri": {
+ "description": "The HCFS URI of the jar file that contains the main class.",
+ "type": "string"
+ },
+ "jarFileUris": {
+ "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "loggingConfig": {
+ "$ref": "LoggingConfig",
+ "description": "Optional. The runtime log config for job execution."
+ },
"properties": {
"additionalProperties": {
"type": "string"
@@ -2659,21 +1941,6 @@
"items": {
"type": "string"
}
- },
- "mainJarFileUri": {
- "description": "The HCFS URI of the jar file that contains the main class.",
- "type": "string"
- },
- "jarFileUris": {
- "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "loggingConfig": {
- "description": "Optional. The runtime log config for job execution.",
- "$ref": "LoggingConfig"
}
},
"id": "SparkJob"
@@ -2683,8 +1950,6 @@
"type": "object",
"properties": {
"state": {
- "description": "Output-only. A state message specifying the overall job state.",
- "type": "string",
"enumDescriptions": [
"The job state is unknown.",
"The job is pending; it has been submitted, but is not yet running.",
@@ -2708,7 +1973,9 @@
"DONE",
"ERROR",
"ATTEMPT_FAILURE"
- ]
+ ],
+ "description": "Output-only. A state message specifying the overall job state.",
+ "type": "string"
},
"details": {
"description": "Output-only. Optional job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e.",
@@ -2720,12 +1987,6 @@
"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",
@@ -2733,26 +1994,25 @@
"STALE_STATUS"
],
"description": "Output-only. Additional state information, which includes status reported by the agent.",
- "type": "string"
+ "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"
},
"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"
@@ -2761,16 +2021,756 @@
"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"
+ "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": {
+ "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"
+ },
+ "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": {
+ "$ref": "ClusterOperationStatus",
+ "description": "Output-only. Current operation status."
+ }
+ },
+ "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"
+ },
+ "GceClusterConfig": {
+ "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "Policy": {
+ "properties": {
+ "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"
+ },
+ "bindings": {
+ "description": "Associates a list of members to a role. bindings with no members will result in an error.",
+ "type": "array",
+ "items": {
+ "$ref": "Binding"
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "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": {
+ "description": "Optional. Disk option config settings.",
+ "$ref": "DiskConfig"
+ },
+ "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": {
+ "$ref": "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."
+ },
+ "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"
+ }
+ }
+ },
+ "id": "InstanceGroupConfig"
+ },
+ "NodeInitializationAction": {
+ "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
+ "type": "object",
+ "properties": {
+ "executableFile": {
+ "description": "Required. Google Cloud Storage URI of executable file.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "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": {
+ "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": {
+ "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."
+ },
+ "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"
+ },
+ "queryList": {
+ "$ref": "QueryList",
+ "description": "A list of queries."
+ },
+ "queryFileUri": {
+ "description": "The HCFS URI of the script that contains SQL queries.",
+ "type": "string"
+ }
+ },
+ "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": {
+ "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",
+ "description": "Cloud Dataproc job config.",
+ "type": "object"
+ },
+ "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": {
+ "enum": [
+ "UNSPECIFIED",
+ "UNHEALTHY",
+ "STALE_STATUS"
+ ],
+ "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.",
+ "The agent-reported status is out of date (may occur if Cloud Dataproc loses communication with Agent).Applies to RUNNING state."
+ ]
+ },
+ "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": {
+ "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"
+ },
+ "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": {
+ "description": "A list of queries.",
+ "$ref": "QueryList"
+ },
+ "queryFileUri": {
+ "description": "The HCFS URI of the script that contains the Pig queries.",
+ "type": "string"
+ }
+ },
+ "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": {
+ "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"
+ },
+ "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."
+ }
+ },
+ "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": {
+ "properties": {
+ "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": {
+ "$ref": "HiveJob",
+ "description": "Job is a Hive job."
+ },
+ "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": {
+ "description": "Job is a Spark job.",
+ "$ref": "SparkJob"
+ },
+ "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": {
+ "$ref": "PySparkJob",
+ "description": "Job is a Pyspark job."
+ },
+ "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"
+ },
+ "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."
+ }
+ },
+ "id": "Job",
+ "description": "A Cloud Dataproc job resource.",
+ "type": "object"
+ },
+ "LifecycleConfig": {
+ "properties": {
+ "autoDeleteTtl": {
+ "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"
+ },
+ "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",
+ "type": "string"
+ }
+ },
+ "id": "LifecycleConfig",
+ "description": "Specifies the cluster auto delete related schedule configuration.",
+ "type": "object"
+ },
+ "ManagedGroupConfig": {
+ "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",
+ "description": "Specifies the resources used to actively manage an instance group.",
+ "type": "object"
+ },
+ "ClusterOperationStatus": {
+ "properties": {
+ "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"
+ },
+ "innerState": {
+ "description": "Output-only. A message containing the detailed operation state.",
+ "type": "string"
+ }
+ },
+ "id": "ClusterOperationStatus",
+ "description": "The status of the operation.",
+ "type": "object"
+ },
+ "ManagedCluster": {
+ "properties": {
+ "config": {
+ "$ref": "ClusterConfig",
+ "description": "Required. The cluster configuration."
+ },
+ "clusterName": {
+ "description": "Required. The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.",
+ "type": "object"
+ }
+ },
+ "id": "ManagedCluster",
+ "description": "Cluster that is managed by the workflow.",
+ "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",
"auth": {
"oauth2": {
"scopes": {
diff --git a/datastore/v1/datastore-api.json b/datastore/v1/datastore-api.json
index e691bef..ef1c8e0 100644
--- a/datastore/v1/datastore-api.json
+++ b/datastore/v1/datastore-api.json
@@ -1,467 +1,40 @@
{
- "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",
- "revision": "20171205",
- "documentationLink": "https://cloud.google.com/datastore/",
- "id": "datastore:v1",
- "title": "Google Cloud Datastore API",
- "ownerName": "Google",
- "discoveryVersion": "v1",
- "version_module": true,
- "resources": {
- "projects": {
- "methods": {
- "beginTransaction": {
- "path": "v1/projects/{projectId}:beginTransaction",
- "id": "datastore.projects.beginTransaction",
- "description": "Begins a new transaction.",
- "request": {
- "$ref": "BeginTransactionRequest"
- },
- "response": {
- "$ref": "BeginTransactionResponse"
- },
- "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}:beginTransaction"
- },
- "commit": {
- "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}:commit",
- "path": "v1/projects/{projectId}:commit",
- "id": "datastore.projects.commit",
- "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.",
- "request": {
- "$ref": "CommitRequest"
- },
- "response": {
- "$ref": "CommitResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST"
- },
- "reserveIds": {
- "request": {
- "$ref": "ReserveIdsRequest"
- },
- "description": "Prevents the supplied keys' IDs from being auto-allocated by Cloud\nDatastore.",
- "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"
- },
- "rollback": {
- "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",
- "description": "Rolls back a transaction.",
- "request": {
- "$ref": "RollbackRequest"
- }
- },
- "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": {
- "description": "Looks up entities by key.",
- "request": {
- "$ref": "LookupRequest"
- },
- "response": {
- "$ref": "LookupResponse"
- },
- "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}:lookup",
- "path": "v1/projects/{projectId}:lookup",
- "id": "datastore.projects.lookup"
- },
- "allocateIds": {
- "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",
- "id": "datastore.projects.allocateIds",
- "path": "v1/projects/{projectId}: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"
- }
- }
- },
- "resources": {
- "operations": {
- "methods": {
- "delete": {
- "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"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "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}"
- },
- "list": {
- "id": "datastore.projects.operations.list",
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleLongrunningListOperationsResponse"
- },
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "pattern": "^projects/[^/]+$",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "flatPath": "v1/projects/{projectsId}/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": "GoogleLongrunningOperation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "datastore.projects.operations.get"
- },
- "cancel": {
- "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.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "datastore.projects.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": {
- "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": {
- "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": {
- "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"
- },
- "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"
- ]
- }
- },
"schemas": {
- "ReserveIdsRequest": {
- "id": "ReserveIdsRequest",
- "description": "The request for Datastore.ReserveIds.",
+ "LookupRequest": {
+ "description": "The request for Datastore.Lookup.",
"type": "object",
"properties": {
"keys": {
+ "description": "Keys of entities to look up.",
+ "type": "array",
+ "items": {
+ "$ref": "Key"
+ }
+ },
+ "readOptions": {
+ "$ref": "ReadOptions",
+ "description": "The options for this lookup request."
+ }
+ },
+ "id": "LookupRequest"
+ },
+ "ReserveIdsRequest": {
+ "properties": {
+ "databaseId": {
+ "description": "If not empty, the ID of the database against which to make the request.",
+ "type": "string"
+ },
+ "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",
+ "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.",
@@ -495,21 +68,21 @@
"type": "object",
"properties": {
"property": {
- "description": "The property to order by.",
- "$ref": "PropertyReference"
+ "$ref": "PropertyReference",
+ "description": "The property to order by."
},
"direction": {
+ "enum": [
+ "DIRECTION_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
"description": "The direction to order by. Defaults to `ASCENDING`.",
"type": "string",
"enumDescriptions": [
"Unspecified. This value must not be used.",
"Ascending.",
"Descending."
- ],
- "enum": [
- "DIRECTION_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
]
}
},
@@ -521,48 +94,48 @@
"properties": {},
"id": "ReserveIdsResponse"
},
- "PropertyReference": {
- "id": "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"
- }
- }
- },
"GoogleDatastoreAdminV1beta1EntityFilter": {
- "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",
"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"
}
- }
- }
- },
- "Projection": {
- "description": "A representation of a property in a projection.",
- "type": "object",
- "properties": {
- "property": {
- "description": "The property to project.",
- "$ref": "PropertyReference"
+ },
+ "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": "Projection"
+ "id": "GoogleDatastoreAdminV1beta1EntityFilter"
+ },
+ "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": {
+ "properties": {
+ "property": {
+ "$ref": "PropertyReference",
+ "description": "The property to project."
+ }
+ },
+ "id": "Projection",
+ "description": "A representation of a property in a projection.",
+ "type": "object"
},
"Mutation": {
"description": "A mutation to apply to an entity.",
@@ -573,8 +146,8 @@
"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",
- "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete."
+ "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.",
@@ -593,13 +166,10 @@
"id": "Mutation"
},
"ReadOptions": {
- "id": "ReadOptions",
"description": "The options shared by read requests.",
"type": "object",
"properties": {
"readConsistency": {
- "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.",
@@ -609,30 +179,26 @@
"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": {
+ "properties": {},
"id": "RollbackResponse",
"description": "The response for Datastore.Rollback.\n(an empty message).",
- "type": "object",
- "properties": {}
+ "type": "object"
},
"MutationResult": {
- "id": "MutationResult",
- "description": "The result of applying a mutation.",
- "type": "object",
"properties": {
- "key": {
- "$ref": "Key",
- "description": "The automatically allocated key.\nSet only when the mutation allocated a 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",
@@ -641,11 +207,17 @@
"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",
+ "description": "The result of applying a mutation.",
+ "type": "object"
},
"RollbackRequest": {
- "id": "RollbackRequest",
"description": "The request for Datastore.Rollback.",
"type": "object",
"properties": {
@@ -654,7 +226,8 @@
"format": "byte",
"type": "string"
}
- }
+ },
+ "id": "RollbackRequest"
},
"GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
"description": "Metadata for ExportEntities operations.",
@@ -665,8 +238,8 @@
"description": "Metadata common to all Datastore Admin operations."
},
"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.",
@@ -684,9 +257,6 @@
"id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata"
},
"CompositeFilter": {
- "id": "CompositeFilter",
- "description": "A filter that merges multiple other filters using the given operator.",
- "type": "object",
"properties": {
"op": {
"enumDescriptions": [
@@ -707,7 +277,10 @@
"$ref": "Filter"
}
}
- }
+ },
+ "id": "CompositeFilter",
+ "description": "A filter that merges multiple other filters using the given operator.",
+ "type": "object"
},
"AllocateIdsResponse": {
"description": "The response for Datastore.AllocateIds.",
@@ -727,33 +300,33 @@
"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"
- }
+ },
+ "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": {
- "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": "GoogleLongrunningOperation"
@@ -762,13 +335,9 @@
"description": "A filter on a specific property.",
"type": "object",
"properties": {
- "value": {
- "$ref": "Value",
- "description": "The value to compare the property to."
- },
"property": {
- "$ref": "PropertyReference",
- "description": "The property to filter by."
+ "description": "The property to filter by.",
+ "$ref": "PropertyReference"
},
"op": {
"description": "The operator to filter by.",
@@ -791,32 +360,34 @@
"EQUAL",
"HAS_ANCESTOR"
]
+ },
+ "value": {
+ "$ref": "Value",
+ "description": "The value to compare the property to."
}
},
"id": "PropertyFilter"
},
"CommitResponse": {
- "id": "CommitResponse",
"description": "The response for Datastore.Commit.",
"type": "object",
"properties": {
- "indexUpdates": {
- "description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
- "format": "int32",
- "type": "integer"
- },
"mutationResults": {
"description": "The result of performing the mutations.\nThe i-th mutation result corresponds to the i-th mutation in the request.",
"type": "array",
"items": {
"$ref": "MutationResult"
}
+ },
+ "indexUpdates": {
+ "description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
+ "format": "int32",
+ "type": "integer"
}
- }
+ },
+ "id": "CommitResponse"
},
"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": {
"namespaceId": {
"description": "If not empty, the ID of the namespace to which the entities belong.",
@@ -827,31 +398,58 @@
"type": "string"
}
},
- "id": "PartitionId"
+ "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"
},
"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"
+ "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"
},
"QueryResultBatch": {
- "id": "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",
+ "type": "string"
+ },
+ "skippedResults": {
+ "description": "The number of results skipped, typically because of an offset.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "entityResultType": {
+ "description": "The result type for every entity in `entity_results`.",
+ "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."
+ ],
+ "enum": [
+ "RESULT_TYPE_UNSPECIFIED",
+ "FULL",
+ "PROJECTION",
+ "KEY_ONLY"
+ ]
+ },
"entityResults": {
"description": "The results for this batch.",
"type": "array",
@@ -860,8 +458,6 @@
}
},
"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.",
@@ -875,7 +471,9 @@
"MORE_RESULTS_AFTER_LIMIT",
"MORE_RESULTS_AFTER_CURSOR",
"NO_MORE_RESULTS"
- ]
+ ],
+ "description": "The state of the query after the current batch.",
+ "type": "string"
},
"endCursor": {
"description": "A cursor that points to the position after the last result in the batch.",
@@ -886,61 +484,29 @@
"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"
- },
- "skippedCursor": {
- "description": "A cursor that points to the position after the last skipped result.\nWill be set when `skipped_results` != 0.",
- "format": "byte",
- "type": "string"
- },
- "skippedResults": {
- "description": "The number of results skipped, typically because of an offset.",
- "format": "int32",
- "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",
- "PROJECTION",
- "KEY_ONLY"
- ],
- "description": "The result type for every entity in `entity_results`.",
- "type": "string"
}
- }
+ },
+ "id": "QueryResultBatch"
},
"GoogleDatastoreAdminV1beta1Progress": {
- "id": "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.",
- "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"
- }
- }
- },
- "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": {
- "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.",
+ },
+ "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"
+ },
+ "PathElement": {
+ "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"
@@ -948,14 +514,18 @@
"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"
}
},
- "id": "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"
},
"GqlQueryParameter": {
- "id": "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.",
@@ -966,11 +536,12 @@
"description": "A value parameter.",
"$ref": "Value"
}
- }
+ },
+ "id": "GqlQueryParameter",
+ "description": "A binding parameter for a GQL query.",
+ "type": "object"
},
"GoogleLongrunningListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -984,11 +555,11 @@
}
}
},
- "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).",
@@ -996,39 +567,11 @@
"type": "string"
}
},
- "id": "BeginTransactionResponse"
- },
- "AllocateIdsRequest": {
- "description": "The request for Datastore.AllocateIds.",
- "type": "object",
- "properties": {
- "keys": {
- "description": "A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only.",
- "type": "array",
- "items": {
- "$ref": "Key"
- }
- }
- },
- "id": "AllocateIdsRequest"
- },
- "RunQueryResponse": {
- "description": "The response for Datastore.RunQuery.",
- "type": "object",
- "properties": {
- "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"
+ "id": "BeginTransactionResponse",
+ "description": "The response for Datastore.BeginTransaction.",
+ "type": "object"
},
"LookupResponse": {
- "id": "LookupResponse",
"description": "The response for Datastore.Lookup.",
"type": "object",
"properties": {
@@ -1053,7 +596,48 @@
"$ref": "EntityResult"
}
}
- }
+ },
+ "id": "LookupResponse"
+ },
+ "RunQueryResponse": {
+ "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"
+ }
+ },
+ "id": "RunQueryResponse"
+ },
+ "AllocateIdsRequest": {
+ "properties": {
+ "keys": {
+ "description": "A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only.",
+ "type": "array",
+ "items": {
+ "$ref": "Key"
+ }
+ }
+ },
+ "id": "AllocateIdsRequest",
+ "description": "The request for Datastore.AllocateIds.",
+ "type": "object"
+ },
+ "BeginTransactionRequest": {
+ "description": "The request for Datastore.BeginTransaction.",
+ "type": "object",
+ "properties": {
+ "transactionOptions": {
+ "description": "Options for a new transaction.",
+ "$ref": "TransactionOptions"
+ }
+ },
+ "id": "BeginTransactionRequest"
},
"CommitRequest": {
"description": "The request for Datastore.Commit.",
@@ -1088,19 +672,7 @@
},
"id": "CommitRequest"
},
- "BeginTransactionRequest": {
- "id": "BeginTransactionRequest",
- "description": "The request for Datastore.BeginTransaction.",
- "type": "object",
- "properties": {
- "transactionOptions": {
- "$ref": "TransactionOptions",
- "description": "Options for a new transaction."
- }
- }
- },
"KindExpression": {
- "id": "KindExpression",
"description": "A representation of a kind.",
"type": "object",
"properties": {
@@ -1108,30 +680,10 @@
"description": "The name of the kind.",
"type": "string"
}
- }
- },
- "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": {
- "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\nAn entity path is always fully complete: *all* of the entity's ancestors\nare required to be in the path along with the entity identifier itself.\nThe only exception is that in some documented cases, the identifier in the\nlast path element (for the entity) itself may be omitted. For example,\nthe last path element of the key of `Mutation.insert` may have no\nidentifier.\n\nA path can never be empty, and a path can have at most 100 elements.",
- "type": "array",
- "items": {
- "$ref": "PathElement"
- }
- },
- "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"
- }
- }
+ },
+ "id": "KindExpression"
},
"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].",
@@ -1143,18 +695,33 @@
"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"
+ },
+ "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": {
+ "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\nAn entity path is always fully complete: *all* of the entity's ancestors\nare required to be in the path along with the entity identifier itself.\nThe only exception is that in some documented cases, the identifier in the\nlast path element (for the entity) itself may be omitted. For example,\nthe last path element of the key of `Mutation.insert` may have no\nidentifier.\n\nA path can never be empty, and a path can have at most 100 elements.",
+ "type": "array",
+ "items": {
+ "$ref": "PathElement"
+ }
+ },
+ "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"
},
"GoogleDatastoreAdminV1beta1CommonMetadata": {
- "id": "GoogleDatastoreAdminV1beta1CommonMetadata",
"description": "Metadata common to all Datastore Admin operations.",
"type": "object",
"properties": {
- "startTime": {
- "description": "The time that work began on the operation.",
- "format": "google-datetime",
- "type": "string"
- },
"labels": {
"additionalProperties": {
"type": "string"
@@ -1168,22 +735,20 @@
"type": "string"
},
"operationType": {
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "EXPORT_ENTITIES",
+ "IMPORT_ENTITIES"
+ ],
"description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
"type": "string",
"enumDescriptions": [
"Unspecified.",
"ExportEntities.",
"ImportEntities."
- ],
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "EXPORT_ENTITIES",
- "IMPORT_ENTITIES"
]
},
"state": {
- "description": "The current state of the Operation.",
- "type": "string",
"enumDescriptions": [
"Unspecified.",
"Request is being prepared for processing.",
@@ -1203,12 +768,19 @@
"SUCCESSFUL",
"FAILED",
"CANCELLED"
- ]
+ ],
+ "description": "The current state of the Operation.",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "The time that work began on the operation.",
+ "format": "google-datetime",
+ "type": "string"
}
- }
+ },
+ "id": "GoogleDatastoreAdminV1beta1CommonMetadata"
},
"ArrayValue": {
- "id": "ArrayValue",
"description": "An array value.",
"type": "object",
"properties": {
@@ -1219,7 +791,8 @@
"$ref": "Value"
}
}
- }
+ },
+ "id": "ArrayValue"
},
"GoogleDatastoreAdminV1beta1ExportEntitiesResponse": {
"description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
@@ -1245,11 +818,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.",
@@ -1270,8 +843,8 @@
"$ref": "CompositeFilter"
},
"propertyFilter": {
- "$ref": "PropertyFilter",
- "description": "A filter on a property."
+ "description": "A filter on a property.",
+ "$ref": "PropertyFilter"
}
},
"id": "Filter"
@@ -1280,34 +853,32 @@
"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."
+ "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"
+ },
+ "readOptions": {
+ "$ref": "ReadOptions",
+ "description": "The options for this query."
+ },
+ "query": {
+ "description": "The query to run.",
+ "$ref": "Query"
}
},
"id": "RunQueryRequest"
},
"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": {}
+ "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": {
"$ref": "ReadWrite",
@@ -1318,7 +889,9 @@
"description": "The transaction should only allow reads."
}
},
- "id": "TransactionOptions"
+ "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"
},
"GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
"description": "Metadata for ImportEntities operations.",
@@ -1329,8 +902,8 @@
"$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.",
@@ -1341,8 +914,8 @@
"$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
},
"progressEntities": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of entities processed."
+ "description": "An estimate of the number of entities processed.",
+ "$ref": "GoogleDatastoreAdminV1beta1Progress"
}
},
"id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata"
@@ -1351,6 +924,37 @@
"description": "A query for entities.",
"type": "object",
"properties": {
+ "projection": {
+ "description": "The projection to return. Defaults to returning all properties.",
+ "type": "array",
+ "items": {
+ "$ref": "Projection"
+ }
+ },
+ "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"
+ },
+ "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": {
+ "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",
@@ -1371,56 +975,20 @@
"items": {
"$ref": "PropertyOrder"
}
- },
- "projection": {
- "description": "The projection to return. Defaults to returning all properties.",
- "type": "array",
- "items": {
- "$ref": "Projection"
- }
- },
- "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"
- },
- "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",
- "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"
}
},
"id": "Query"
},
"ReadOnly": {
- "id": "ReadOnly",
"description": "Options specific to read-only transactions.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "ReadOnly"
},
"EntityResult": {
"description": "The result of fetching an entity from Datastore.",
"type": "object",
"properties": {
- "version": {
- "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"
@@ -1429,14 +997,38 @@
"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",
"type": "string"
+ },
+ "version": {
+ "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"
}
},
"id": "EntityResult"
},
"Value": {
- "description": "A message that can hold any of the supported value types and associated\nmetadata.",
- "type": "object",
"properties": {
+ "entityValue": {
+ "$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": {
+ "$ref": "Key",
+ "description": "A key value."
+ },
+ "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"
@@ -1451,10 +1043,6 @@
"format": "google-datetime",
"type": "string"
},
- "booleanValue": {
- "description": "A boolean value.",
- "type": "boolean"
- },
"nullValue": {
"enumDescriptions": [
"Null value."
@@ -1465,6 +1053,10 @@
"description": "A 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.",
"format": "byte",
@@ -1478,30 +1070,11 @@
"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.",
- "$ref": "Entity"
- },
- "geoPointValue": {
- "$ref": "LatLng",
- "description": "A geo point value representing a point on the surface of Earth."
- },
- "keyValue": {
- "$ref": "Key",
- "description": "A key value."
- },
- "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"
}
},
- "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.",
@@ -1514,29 +1087,456 @@
}
},
"id": "ReadWrite"
- },
- "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"
}
},
+ "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"
+ "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",
+ "revision": "20171212",
+ "documentationLink": "https://cloud.google.com/datastore/",
+ "id": "datastore:v1",
+ "title": "Google Cloud Datastore API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
+ "version_module": true,
+ "resources": {
+ "projects": {
+ "methods": {
+ "allocateIds": {
+ "response": {
+ "$ref": "AllocateIdsResponse"
+ },
+ "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}:allocateIds",
+ "path": "v1/projects/{projectId}:allocateIds",
+ "id": "datastore.projects.allocateIds",
+ "request": {
+ "$ref": "AllocateIdsRequest"
+ },
+ "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted."
+ },
+ "beginTransaction": {
+ "request": {
+ "$ref": "BeginTransactionRequest"
+ },
+ "description": "Begins a new transaction.",
+ "response": {
+ "$ref": "BeginTransactionResponse"
+ },
+ "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}:beginTransaction",
+ "path": "v1/projects/{projectId}:beginTransaction",
+ "id": "datastore.projects.beginTransaction"
+ },
+ "commit": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "CommitResponse"
+ },
+ "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",
+ "id": "datastore.projects.commit",
+ "path": "v1/projects/{projectId}:commit",
+ "request": {
+ "$ref": "CommitRequest"
+ },
+ "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities."
+ },
+ "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",
+ "path": "v1/projects/{projectId}:reserveIds",
+ "id": "datastore.projects.reserveIds"
+ },
+ "rollback": {
+ "flatPath": "v1/projects/{projectId}:rollback",
+ "path": "v1/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"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the project against which to make the request.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "runQuery": {
+ "request": {
+ "$ref": "RunQueryRequest"
+ },
+ "description": "Queries for entities.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "RunQueryResponse"
+ },
+ "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}:runQuery",
+ "id": "datastore.projects.runQuery",
+ "path": "v1/projects/{projectId}:runQuery"
+ },
+ "lookup": {
+ "path": "v1/projects/{projectId}:lookup",
+ "id": "datastore.projects.lookup",
+ "description": "Looks up entities by key.",
+ "request": {
+ "$ref": "LookupRequest"
+ },
+ "response": {
+ "$ref": "LookupResponse"
+ },
+ "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}:lookup"
+ }
+ },
+ "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",
+ "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.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "datastore.projects.operations.cancel"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "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 deleted.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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`."
+ },
+ "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"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "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/[^/]+$",
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/operations",
+ "path": "v1/{+name}/operations",
+ "id": "datastore.projects.operations.list"
+ },
+ "get": {
+ "path": "v1/{+name}",
+ "id": "datastore.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": "GoogleLongrunningOperation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/operations/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "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": {
+ "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": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ }
+ }
}
diff --git a/datastore/v1beta1/datastore-api.json b/datastore/v1beta1/datastore-api.json
index c325106..0a26282 100644
--- a/datastore/v1beta1/datastore-api.json
+++ b/datastore/v1beta1/datastore-api.json
@@ -1,23 +1,36 @@
{
+ "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": "20171205",
+ "revision": "20171212",
"documentationLink": "https://cloud.google.com/datastore/",
"id": "datastore:v1beta1",
"title": "Google Cloud Datastore API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"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"
},
@@ -25,79 +38,62 @@
"projectId"
],
"httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "description": "Project ID 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"
],
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Project ID against which to make the request."
- }
- },
"flatPath": "v1beta1/projects/{projectId}:export",
"path": "v1beta1/projects/{projectId}:export",
- "id": "datastore.projects.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",
+ "parameters": {
+ "projectId": {
+ "description": "Project ID 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": "v1beta1/projects/{projectId}:import",
"path": "v1beta1/projects/{projectId}:import",
"id": "datastore.projects.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"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Project ID against which to make the request."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ]
+ "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."
}
}
}
},
"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": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Pretty-print response."
- },
- "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"
- },
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
"location": "query",
@@ -106,21 +102,17 @@
"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": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
"$.xgafv": {
+ "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
@@ -130,15 +122,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",
@@ -147,21 +138,209 @@
],
"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"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
},
"access_token": {
- "location": "query",
"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": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
"type": "string"
}
},
"schemas": {
+ "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
+ "description": "Metadata for ExportEntities operations.",
+ "type": "object",
+ "properties": {
+ "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."
+ },
+ "common": {
+ "description": "Metadata common to all Datastore Admin operations.",
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata"
+ },
+ "GoogleDatastoreAdminV1beta1ExportEntitiesRequest": {
+ "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.",
+ "type": "object",
+ "properties": {
+ "entityFilter": {
+ "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
+ "description": "Description of what data from the project is included in the export."
+ },
+ "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": {
+ "description": "Client-assigned labels.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "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"
+ },
+ "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
+ "description": "Metadata for ImportEntities operations.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "An estimate of the number of entities processed.",
+ "$ref": "GoogleDatastoreAdminV1beta1Progress"
+ },
+ "common": {
+ "description": "Metadata common to all Datastore Admin operations.",
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata"
+ },
+ "GoogleDatastoreAdminV1beta1ImportEntitiesRequest": {
+ "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities.",
+ "type": "object",
+ "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": {
+ "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"
+ },
+ "labels": {
+ "description": "Client-assigned labels.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest"
+ },
+ "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.",
+ "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"
+ },
+ "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": {
+ "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": {
+ "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": {
"kinds": {
@@ -179,53 +358,18 @@
}
}
},
- "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']"
- },
- "GoogleLongrunningOperation": {
- "type": "object",
- "properties": {
- "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."
- },
- "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`."
- },
- "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."
- }
- },
- "id": "GoogleLongrunningOperation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
+ "id": "GoogleDatastoreAdminV1beta1EntityFilter"
},
"GoogleDatastoreAdminV1beta1CommonMetadata": {
+ "description": "Metadata common to all Datastore Admin operations.",
"type": "object",
"properties": {
"labels": {
+ "description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels.",
"type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels."
+ }
},
"endTime": {
"description": "The time the operation ended, either successfully or otherwise.",
@@ -233,21 +377,20 @@
"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",
- "enumDescriptions": [
- "Unspecified.",
- "ExportEntities.",
- "ImportEntities."
- ]
+ "type": "string"
},
"state": {
- "type": "string",
"enumDescriptions": [
"Unspecified.",
"Request is being prepared for processing.",
@@ -268,7 +411,8 @@
"FAILED",
"CANCELLED"
],
- "description": "The current state of the Operation."
+ "description": "The current state of the Operation.",
+ "type": "string"
},
"startTime": {
"description": "The time that work began on the operation.",
@@ -276,184 +420,40 @@
"type": "string"
}
},
- "id": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations."
+ "id": "GoogleDatastoreAdminV1beta1CommonMetadata"
},
"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": {
- "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": {
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- }
- },
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
- }
- },
- "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."
- },
- "GoogleDatastoreAdminV1beta1ExportEntitiesRequest": {
- "type": "object",
- "properties": {
- "entityFilter": {
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Description of what data from the project is included in the export."
- },
- "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",
- "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities."
- },
- "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
- "type": "object",
- "properties": {
- "common": {
- "$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."
- },
- "outputUrlPrefix": {
- "type": "string",
- "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."
- },
- "progressEntities": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of entities processed."
- }
- },
- "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata",
- "description": "Metadata for ExportEntities operations."
- },
- "GoogleDatastoreAdminV1beta1ExportEntitiesResponse": {
- "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.",
+ "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": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse",
- "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities."
- },
- "GoogleDatastoreAdminV1beta1ImportEntitiesRequest": {
- "type": "object",
- "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": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Client-assigned labels."
- }
- },
- "id": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest",
- "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities."
- },
- "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
- "description": "Metadata for ImportEntities operations.",
- "type": "object",
- "properties": {
- "entityFilter": {
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter",
- "description": "Description of which entities are being imported."
- },
- "progressEntities": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of entities processed."
- },
- "common": {
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations."
- },
- "progressBytes": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of bytes processed."
- },
- "inputUrl": {
- "type": "string",
- "description": "The location of the import metadata file. This will be the same value as\nthe google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield."
- }
- },
- "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata"
- },
- "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.",
- "format": "int64",
- "type": "string"
- },
- "workCompleted": {
- "type": "string",
- "description": "The amount of work that has been completed. Note that this may be greater\nthan work_estimated.",
- "format": "int64"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1Progress"
+ "id": "Status"
}
},
- "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": "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"
- }
- }
- }
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "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/"
+ "version": "v1beta1"
}
diff --git a/datastore/v1beta3/datastore-api.json b/datastore/v1beta3/datastore-api.json
index 0e84d26..cb8b8ec 100644
--- a/datastore/v1beta3/datastore-api.json
+++ b/datastore/v1beta3/datastore-api.json
@@ -1,26 +1,152 @@
{
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "datastore",
- "batchPath": "batch",
- "id": "datastore:v1beta3",
- "documentationLink": "https://cloud.google.com/datastore/",
- "revision": "20171205",
- "title": "Google Cloud Datastore API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"version_module": true,
"resources": {
"projects": {
"methods": {
- "rollback": {
- "path": "v1beta3/projects/{projectId}:rollback",
- "id": "datastore.projects.rollback",
- "description": "Rolls back a transaction.",
+ "allocateIds": {
+ "path": "v1beta3/projects/{projectId}:allocateIds",
+ "id": "datastore.projects.allocateIds",
+ "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.",
"request": {
- "$ref": "RollbackRequest"
+ "$ref": "AllocateIdsRequest"
},
"response": {
+ "$ref": "AllocateIdsResponse"
+ },
+ "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": "v1beta3/projects/{projectId}:allocateIds"
+ },
+ "commit": {
+ "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.",
+ "request": {
+ "$ref": "CommitRequest"
+ },
+ "response": {
+ "$ref": "CommitResponse"
+ },
+ "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": "v1beta3/projects/{projectId}:commit",
+ "path": "v1beta3/projects/{projectId}:commit",
+ "id": "datastore.projects.commit"
+ },
+ "beginTransaction": {
+ "response": {
+ "$ref": "BeginTransactionResponse"
+ },
+ "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": "v1beta3/projects/{projectId}:beginTransaction",
+ "path": "v1beta3/projects/{projectId}:beginTransaction",
+ "id": "datastore.projects.beginTransaction",
+ "description": "Begins a new transaction.",
+ "request": {
+ "$ref": "BeginTransactionRequest"
+ }
+ },
+ "reserveIds": {
+ "response": {
+ "$ref": "ReserveIdsResponse"
+ },
+ "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}:reserveIds",
+ "path": "v1beta3/projects/{projectId}:reserveIds",
+ "id": "datastore.projects.reserveIds",
+ "request": {
+ "$ref": "ReserveIdsRequest"
+ },
+ "description": "Prevents the supplied keys' IDs from being auto-allocated by Cloud\nDatastore."
+ },
+ "runQuery": {
+ "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": "v1beta3/projects/{projectId}:runQuery",
+ "path": "v1beta3/projects/{projectId}:runQuery",
+ "id": "datastore.projects.runQuery",
+ "description": "Queries for entities.",
+ "request": {
+ "$ref": "RunQueryRequest"
+ }
+ },
+ "rollback": {
+ "response": {
"$ref": "RollbackResponse"
},
"parameterOrder": [
@@ -33,50 +159,28 @@
],
"parameters": {
"projectId": {
- "location": "path",
- "description": "The ID of the project against which to make the request.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta3/projects/{projectId}:rollback"
- },
- "runQuery": {
- "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": "v1beta3/projects/{projectId}:runQuery",
- "path": "v1beta3/projects/{projectId}:runQuery",
- "id": "datastore.projects.runQuery",
- "description": "Queries for entities.",
+ "flatPath": "v1beta3/projects/{projectId}:rollback",
+ "path": "v1beta3/projects/{projectId}:rollback",
+ "id": "datastore.projects.rollback",
+ "description": "Rolls back a transaction.",
"request": {
- "$ref": "RunQueryRequest"
- },
- "response": {
- "$ref": "RunQueryResponse"
- },
+ "$ref": "RollbackRequest"
+ }
+ },
+ "lookup": {
+ "httpMethod": "POST",
"parameterOrder": [
"projectId"
],
- "httpMethod": "POST"
- },
- "lookup": {
"response": {
"$ref": "LookupResponse"
},
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
"parameters": {
"projectId": {
"description": "The ID of the project against which to make the request.",
@@ -90,124 +194,12 @@
"https://www.googleapis.com/auth/datastore"
],
"flatPath": "v1beta3/projects/{projectId}:lookup",
- "path": "v1beta3/projects/{projectId}:lookup",
"id": "datastore.projects.lookup",
+ "path": "v1beta3/projects/{projectId}:lookup",
"request": {
"$ref": "LookupRequest"
},
"description": "Looks up entities by key."
- },
- "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": "v1beta3/projects/{projectId}:allocateIds",
- "id": "datastore.projects.allocateIds",
- "path": "v1beta3/projects/{projectId}: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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the project against which to make the request."
- }
- },
- "flatPath": "v1beta3/projects/{projectId}:beginTransaction",
- "id": "datastore.projects.beginTransaction",
- "path": "v1beta3/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": "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."
- },
- "reserveIds": {
- "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}:reserveIds",
- "id": "datastore.projects.reserveIds",
- "path": "v1beta3/projects/{projectId}:reserveIds",
- "request": {
- "$ref": "ReserveIdsRequest"
- },
- "description": "Prevents the supplied keys' IDs from being auto-allocated by Cloud\nDatastore.",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "ReserveIdsResponse"
- }
}
}
}
@@ -219,71 +211,73 @@
"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"
+ "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"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "default": "true",
+ "location": "query"
},
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
- "upload_protocol": {
+ "oauth_token": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "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"
},
- "uploadType": {
+ "fields": {
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "fields": {
- "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": {
- "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"
},
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -295,12 +289,614 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
+ "location": "query"
}
},
"schemas": {
+ "GqlQueryParameter": {
+ "properties": {
+ "cursor": {
+ "description": "A query cursor. Query cursors are returned in query\nresult batches.",
+ "format": "byte",
+ "type": "string"
+ },
+ "value": {
+ "$ref": "Value",
+ "description": "A value parameter."
+ }
+ },
+ "id": "GqlQueryParameter",
+ "description": "A binding parameter for a GQL query.",
+ "type": "object"
+ },
+ "BeginTransactionResponse": {
+ "description": "The response for Datastore.BeginTransaction.",
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "description": "The transaction identifier (always present).",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "BeginTransactionResponse"
+ },
+ "RunQueryResponse": {
+ "properties": {
+ "batch": {
+ "$ref": "QueryResultBatch",
+ "description": "A batch of query results (always present)."
+ },
+ "query": {
+ "description": "The parsed form of the `GqlQuery` from the request, if it was set.",
+ "$ref": "Query"
+ }
+ },
+ "id": "RunQueryResponse",
+ "description": "The response for Datastore.RunQuery.",
+ "type": "object"
+ },
+ "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",
+ "items": {
+ "$ref": "EntityResult"
+ }
+ },
+ "missing": {
+ "description": "Entities not found as `ResultType.KEY_ONLY` entities. The order of results\nin this field is undefined and has no relation to the order of the keys\nin the input.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityResult"
+ }
+ }
+ },
+ "id": "LookupResponse"
+ },
+ "AllocateIdsRequest": {
+ "properties": {
+ "keys": {
+ "description": "A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only.",
+ "type": "array",
+ "items": {
+ "$ref": "Key"
+ }
+ }
+ },
+ "id": "AllocateIdsRequest",
+ "description": "The request for Datastore.AllocateIds.",
+ "type": "object"
+ },
+ "PropertyOrder": {
+ "description": "The desired order for a specific property.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "PropertyReference",
+ "description": "The property to order by."
+ },
+ "direction": {
+ "enum": [
+ "DIRECTION_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "description": "The direction to order by. Defaults to `ASCENDING`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Ascending.",
+ "Descending."
+ ]
+ }
+ },
+ "id": "PropertyOrder"
+ },
+ "BeginTransactionRequest": {
+ "description": "The request for Datastore.BeginTransaction.",
+ "type": "object",
+ "properties": {
+ "transactionOptions": {
+ "$ref": "TransactionOptions",
+ "description": "Options for a new transaction."
+ }
+ },
+ "id": "BeginTransactionRequest"
+ },
+ "CommitRequest": {
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "id": "CommitRequest",
+ "description": "The request for Datastore.Commit.",
+ "type": "object"
+ },
+ "KindExpression": {
+ "properties": {
+ "name": {
+ "description": "The name of the kind.",
+ "type": "string"
+ }
+ },
+ "id": "KindExpression",
+ "description": "A representation of a kind.",
+ "type": "object"
+ },
+ "Key": {
+ "properties": {
+ "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\nAn entity path is always fully complete: *all* of the entity's ancestors\nare required to be in the path along with the entity identifier itself.\nThe only exception is that in some documented cases, the identifier in the\nlast path element (for the entity) itself may be omitted. For example,\nthe last path element of the key of `Mutation.insert` may have no\nidentifier.\n\nA path can never be empty, and a path can have at most 100 elements.",
+ "type": "array",
+ "items": {
+ "$ref": "PathElement"
+ }
+ },
+ "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"
+ }
+ },
+ "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"
+ },
+ "LatLng": {
+ "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"
+ }
+ },
+ "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": {
+ "properties": {},
+ "id": "ReserveIdsResponse",
+ "description": "The response for Datastore.ReserveIds.",
+ "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"
+ },
+ "GoogleDatastoreAdminV1beta1EntityFilter": {
+ "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",
+ "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"
+ },
+ "GoogleDatastoreAdminV1beta1CommonMetadata": {
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels.",
+ "type": "object"
+ },
+ "endTime": {
+ "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": {
+ "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"
+ ],
+ "description": "The current state of the Operation.",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "The time that work began on the operation.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1CommonMetadata",
+ "description": "Metadata common to all Datastore Admin operations.",
+ "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"
+ },
+ "ArrayValue": {
+ "description": "An array value.",
+ "type": "object",
+ "properties": {
+ "values": {
+ "description": "Values in the array.\nThe order of this array may not be preserved if it contains a mix of\nindexed and unindexed values.",
+ "type": "array",
+ "items": {
+ "$ref": "Value"
+ }
+ }
+ },
+ "id": "ArrayValue"
+ },
+ "Mutation": {
+ "description": "A mutation to apply to an entity.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "$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": {
+ "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."
+ }
+ },
+ "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"
+ },
+ "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"
+ },
+ "MutationResult": {
+ "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"
+ }
+ },
+ "id": "MutationResult",
+ "description": "The result of applying a mutation.",
+ "type": "object"
+ },
+ "GqlQuery": {
+ "properties": {
+ "queryString": {
+ "description": "A string of the format described\n[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
+ "type": "string"
+ },
+ "allowLiterals": {
+ "description": "When false, the query string must not contain any literals and instead must\nbind all values. For example,\n`SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while\n`SELECT * FROM Kind WHERE a = @value` is.",
+ "type": "boolean"
+ },
+ "namedBindings": {
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "GqlQueryParameter"
+ }
+ }
+ },
+ "id": "GqlQuery",
+ "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).",
+ "type": "object"
+ },
+ "Filter": {
+ "properties": {
+ "propertyFilter": {
+ "description": "A filter on a property.",
+ "$ref": "PropertyFilter"
+ },
+ "compositeFilter": {
+ "description": "A composite filter.",
+ "$ref": "CompositeFilter"
+ }
+ },
+ "id": "Filter",
+ "description": "A holder for any type of filter.",
+ "type": "object"
+ },
+ "RollbackRequest": {
+ "properties": {
+ "transaction": {
+ "description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "RollbackRequest",
+ "description": "The request for Datastore.Rollback.",
+ "type": "object"
+ },
+ "RunQueryRequest": {
+ "description": "The request for Datastore.RunQuery.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "$ref": "GqlQuery",
+ "description": "The GQL query to run."
+ },
+ "readOptions": {
+ "description": "The options for this query.",
+ "$ref": "ReadOptions"
+ },
+ "query": {
+ "description": "The query to run.",
+ "$ref": "Query"
+ }
+ },
+ "id": "RunQueryRequest"
+ },
+ "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."
+ },
+ "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"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata"
+ },
+ "TransactionOptions": {
+ "properties": {
+ "readWrite": {
+ "description": "The transaction should allow both reads and writes.",
+ "$ref": "ReadWrite"
+ },
+ "readOnly": {
+ "$ref": "ReadOnly",
+ "description": "The transaction should only allow reads."
+ }
+ },
+ "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"
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "Filter"
+ }
+ },
+ "op": {
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "The results are required to satisfy each of the combined filters."
+ ],
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "AND"
+ ],
+ "description": "The operator for combining multiple filters.",
+ "type": "string"
+ }
+ },
+ "id": "CompositeFilter"
+ },
+ "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
+ "properties": {
+ "progressEntities": {
+ "description": "An estimate of the number of entities processed.",
+ "$ref": "GoogleDatastoreAdminV1beta1Progress"
+ },
+ "common": {
+ "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
+ "description": "Metadata common to all Datastore Admin operations."
+ },
+ "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"
+ }
+ },
+ "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata",
+ "description": "Metadata for ImportEntities operations.",
+ "type": "object"
+ },
+ "AllocateIdsResponse": {
+ "properties": {
+ "keys": {
+ "description": "The keys specified in the request (in the same order), each with\nits key path completed with a newly allocated ID.",
+ "type": "array",
+ "items": {
+ "$ref": "Key"
+ }
+ }
+ },
+ "id": "AllocateIdsResponse",
+ "description": "The response for Datastore.AllocateIds.",
+ "type": "object"
+ },
"Query": {
"properties": {
"projection": {
@@ -325,9 +921,9 @@
"$ref": "Filter"
},
"startCursor": {
- "type": "string",
"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"
+ "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.",
@@ -361,15 +957,12 @@
"type": "object"
},
"ReadOnly": {
- "type": "object",
"properties": {},
"id": "ReadOnly",
- "description": "Options specific to read-only transactions."
+ "description": "Options specific to read-only transactions.",
+ "type": "object"
},
"PropertyFilter": {
- "id": "PropertyFilter",
- "description": "A filter on a specific property.",
- "type": "object",
"properties": {
"value": {
"$ref": "Value",
@@ -380,6 +973,15 @@
"$ref": "PropertyReference"
},
"op": {
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "LESS_THAN",
+ "LESS_THAN_OR_EQUAL",
+ "GREATER_THAN",
+ "GREATER_THAN_OR_EQUAL",
+ "EQUAL",
+ "HAS_ANCESTOR"
+ ],
"description": "The operator to filter by.",
"type": "string",
"enumDescriptions": [
@@ -390,18 +992,12 @@
"Greater than or equal.",
"Equal.",
"Has ancestor."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "LESS_THAN",
- "LESS_THAN_OR_EQUAL",
- "GREATER_THAN",
- "GREATER_THAN_OR_EQUAL",
- "EQUAL",
- "HAS_ANCESTOR"
]
}
- }
+ },
+ "id": "PropertyFilter",
+ "description": "A filter on a specific property.",
+ "type": "object"
},
"EntityResult": {
"description": "The result of fetching an entity from Datastore.",
@@ -425,8 +1021,6 @@
"id": "EntityResult"
},
"CommitResponse": {
- "description": "The response for Datastore.Commit.",
- "type": "object",
"properties": {
"indexUpdates": {
"description": "The number of index entries updated during the commit, or zero if none were\nupdated.",
@@ -441,12 +1035,45 @@
}
}
},
- "id": "CommitResponse"
+ "id": "CommitResponse",
+ "description": "The response for Datastore.Commit.",
+ "type": "object"
},
"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"
+ },
+ "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"
+ },
"entityValue": {
"$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."
@@ -456,8 +1083,8 @@
"$ref": "LatLng"
},
"keyValue": {
- "description": "A key value.",
- "$ref": "Key"
+ "$ref": "Key",
+ "description": "A key value."
},
"integerValue": {
"description": "An integer value.",
@@ -476,54 +1103,23 @@
"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": {
- "type": "string",
- "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"
- },
- "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"
+ "id": "Value",
+ "description": "A message that can hold any of the supported value types and associated\nmetadata.",
+ "type": "object"
},
"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.",
+ "type": "string"
+ },
"namespaceId": {
"description": "If not empty, the ID of the namespace to which the entities belong.",
"type": "string"
- },
- "projectId": {
- "type": "string",
- "description": "The ID of the project to which the entities belong."
}
},
"id": "PartitionId"
@@ -541,8 +1137,6 @@
"type": "object"
},
"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": {
"$ref": "Key",
@@ -556,17 +1150,19 @@
"type": "object"
}
},
- "id": "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"
},
"GoogleDatastoreAdminV1beta1Progress": {
"properties": {
- "workEstimated": {
- "description": "An estimate of how much work needs to be performed. May be zero if the\nwork estimate is unavailable.",
+ "workCompleted": {
+ "description": "The amount of work that has been completed. Note that this may be greater\nthan work_estimated.",
"format": "int64",
"type": "string"
},
- "workCompleted": {
- "description": "The amount of work that has been completed. Note that this may be greater\nthan work_estimated.",
+ "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"
}
@@ -576,10 +1172,15 @@
"type": "object"
},
"QueryResultBatch": {
- "description": "A batch of results produced by a query.",
- "type": "object",
"properties": {
"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",
@@ -588,19 +1189,12 @@
"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."
- ]
+ "type": "string"
},
"endCursor": {
- "type": "string",
"description": "A cursor that points to the position after the last result in the batch.",
- "format": "byte"
+ "format": "byte",
+ "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.",
@@ -618,6 +1212,12 @@
"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",
@@ -625,13 +1225,7 @@
"KEY_ONLY"
],
"description": "The result type for every entity in `entity_results`.",
- "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."
- ]
+ "type": "string"
},
"entityResults": {
"description": "The results for this batch.",
@@ -641,15 +1235,15 @@
}
}
},
- "id": "QueryResultBatch"
+ "id": "QueryResultBatch",
+ "description": "A batch of results produced by a query.",
+ "type": "object"
},
"LookupRequest": {
- "description": "The request for Datastore.Lookup.",
- "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.",
@@ -659,25 +1253,27 @@
}
}
},
- "id": "LookupRequest"
+ "id": "LookupRequest",
+ "description": "The request for Datastore.Lookup.",
+ "type": "object"
},
"ReserveIdsRequest": {
- "type": "object",
"properties": {
- "databaseId": {
- "description": "If not empty, the ID of the database against which to make the request.",
- "type": "string"
- },
"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",
- "description": "The request for Datastore.ReserveIds."
+ "description": "The request for Datastore.ReserveIds.",
+ "type": "object"
},
"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.",
@@ -693,615 +1289,11 @@
"type": "string"
},
"kind": {
- "type": "string",
- "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 `\"\"`."
+ "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"
- },
- "GqlQueryParameter": {
- "properties": {
- "cursor": {
- "type": "string",
- "description": "A query cursor. Query cursors are returned in query\nresult batches.",
- "format": "byte"
- },
- "value": {
- "$ref": "Value",
- "description": "A value parameter."
- }
- },
- "id": "GqlQueryParameter",
- "description": "A binding parameter for a GQL query.",
- "type": "object"
- },
- "BeginTransactionResponse": {
- "type": "object",
- "properties": {
- "transaction": {
- "description": "The transaction identifier (always present).",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "BeginTransactionResponse",
- "description": "The response for Datastore.BeginTransaction."
- },
- "RunQueryResponse": {
- "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"
- }
- },
- "id": "RunQueryResponse"
- },
- "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",
- "items": {
- "$ref": "EntityResult"
- }
- },
- "missing": {
- "description": "Entities not found as `ResultType.KEY_ONLY` entities. The order of results\nin this field is undefined and has no relation to the order of the keys\nin the input.",
- "type": "array",
- "items": {
- "$ref": "EntityResult"
- }
- }
- },
- "id": "LookupResponse"
- },
- "AllocateIdsRequest": {
- "properties": {
- "keys": {
- "type": "array",
- "items": {
- "$ref": "Key"
- },
- "description": "A list of keys with incomplete key paths for which to allocate IDs.\nNo key may be reserved/read-only."
- }
- },
- "id": "AllocateIdsRequest",
- "description": "The request for Datastore.AllocateIds.",
- "type": "object"
- },
- "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"
- },
- "BeginTransactionRequest": {
- "properties": {
- "transactionOptions": {
- "$ref": "TransactionOptions",
- "description": "Options for a new transaction."
- }
- },
- "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": {
- "description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.",
- "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."
- ],
- "enum": [
- "MODE_UNSPECIFIED",
- "TRANSACTIONAL",
- "NON_TRANSACTIONAL"
- ]
- },
- "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"
- }
- }
- },
- "id": "CommitRequest"
- },
- "KindExpression": {
- "description": "A representation of a kind.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the kind.",
- "type": "string"
- }
- },
- "id": "KindExpression"
- },
- "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": {
- "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\nAn entity path is always fully complete: *all* of the entity's ancestors\nare required to be in the path along with the entity identifier itself.\nThe only exception is that in some documented cases, the identifier in the\nlast path element (for the entity) itself may be omitted. For example,\nthe last path element of the key of `Mutation.insert` may have no\nidentifier.\n\nA path can never be empty, and a path can have at most 100 elements.",
- "type": "array",
- "items": {
- "$ref": "PathElement"
- }
- },
- "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": {
- "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"
- },
- "ReserveIdsResponse": {
- "type": "object",
- "properties": {},
- "id": "ReserveIdsResponse",
- "description": "The response for Datastore.ReserveIds."
- },
- "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"
- },
- "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": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "If empty, then this represents all kinds."
- }
- },
- "id": "GoogleDatastoreAdminV1beta1EntityFilter"
- },
- "GoogleDatastoreAdminV1beta1CommonMetadata": {
- "type": "object",
- "properties": {
- "startTime": {
- "description": "The time that work began on the operation.",
- "format": "google-datetime",
- "type": "string"
- },
- "labels": {
- "description": "The client-assigned labels which were provided when the operation was\ncreated. May also include additional labels.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "endTime": {
- "description": "The time the operation ended, either successfully or otherwise.",
- "format": "google-datetime",
- "type": "string"
- },
- "operationType": {
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "EXPORT_ENTITIES",
- "IMPORT_ENTITIES"
- ],
- "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "ExportEntities.",
- "ImportEntities."
- ]
- },
- "state": {
- "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"
- ],
- "description": "The current state of the Operation."
- }
- },
- "id": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations."
- },
- "Projection": {
- "description": "A representation of a property in a projection.",
- "type": "object",
- "properties": {
- "property": {
- "$ref": "PropertyReference",
- "description": "The property to project."
- }
- },
- "id": "Projection"
- },
- "ArrayValue": {
- "id": "ArrayValue",
- "description": "An array value.",
- "type": "object",
- "properties": {
- "values": {
- "description": "Values in the array.\nThe order of this array may not be preserved if it contains a mix of\nindexed and unindexed values.",
- "type": "array",
- "items": {
- "$ref": "Value"
- }
- }
- }
- },
- "Mutation": {
- "description": "A mutation to apply to an entity.",
- "type": "object",
- "properties": {
- "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."
- },
- "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"
- },
- "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."
- }
- },
- "id": "Mutation"
- },
- "ReadOptions": {
- "properties": {
- "readConsistency": {
- "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."
- ],
- "enum": [
- "READ_CONSISTENCY_UNSPECIFIED",
- "STRONG",
- "EVENTUAL"
- ]
- },
- "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"
- },
- "RollbackResponse": {
- "description": "The response for Datastore.Rollback.\n(an empty message).",
- "type": "object",
- "properties": {},
- "id": "RollbackResponse"
- },
- "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"
- },
- "MutationResult": {
- "id": "MutationResult",
- "description": "The result of applying a mutation.",
- "type": "object",
- "properties": {
- "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."
- },
- "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"
- }
- }
- },
- "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).",
- "type": "string"
- },
- "allowLiterals": {
- "description": "When false, the query string must not contain any literals and instead must\nbind all values. For example,\n`SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while\n`SELECT * FROM Kind WHERE a = @value` is.",
- "type": "boolean"
- },
- "namedBindings": {
- "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.",
- "type": "array",
- "items": {
- "$ref": "GqlQueryParameter"
- }
- }
- },
- "id": "GqlQuery"
- },
- "Filter": {
- "properties": {
- "propertyFilter": {
- "$ref": "PropertyFilter",
- "description": "A filter on a property."
- },
- "compositeFilter": {
- "$ref": "CompositeFilter",
- "description": "A composite filter."
- }
- },
- "id": "Filter",
- "description": "A holder for any type of filter.",
- "type": "object"
- },
- "RollbackRequest": {
- "description": "The request for Datastore.Rollback.",
- "type": "object",
- "properties": {
- "transaction": {
- "description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "RollbackRequest"
- },
- "RunQueryRequest": {
- "description": "The request for Datastore.RunQuery.",
- "type": "object",
- "properties": {
- "readOptions": {
- "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."
- },
- "gqlQuery": {
- "$ref": "GqlQuery",
- "description": "The GQL query to run."
- }
- },
- "id": "RunQueryRequest"
- },
- "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": {
- "properties": {
- "progressEntities": {
- "description": "An estimate of the number of entities processed.",
- "$ref": "GoogleDatastoreAdminV1beta1Progress"
- },
- "common": {
- "$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."
- },
- "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"
- }
- },
- "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata",
- "description": "Metadata for ExportEntities operations.",
- "type": "object"
- },
- "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."
- }
- },
- "id": "TransactionOptions"
- },
- "CompositeFilter": {
- "description": "A filter that merges multiple other filters using the given operator.",
- "type": "object",
- "properties": {
- "filters": {
- "type": "array",
- "items": {
- "$ref": "Filter"
- },
- "description": "The list of filters to combine.\nMust contain at least one filter."
- },
- "op": {
- "type": "string",
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "The results are required to satisfy each of the combined filters."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "AND"
- ],
- "description": "The operator for combining multiple filters."
- }
- },
- "id": "CompositeFilter"
- },
- "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": {
- "description": "Metadata for ImportEntities operations.",
- "type": "object",
- "properties": {
- "entityFilter": {
- "description": "Description of which entities are being imported.",
- "$ref": "GoogleDatastoreAdminV1beta1EntityFilter"
- },
- "progressEntities": {
- "$ref": "GoogleDatastoreAdminV1beta1Progress",
- "description": "An estimate of the number of entities processed."
- },
- "common": {
- "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata",
- "description": "Metadata common to all Datastore Admin operations."
- },
- "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"
- }
- },
- "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.",
- "type": "array",
- "items": {
- "$ref": "Key"
- }
- }
- },
- "id": "AllocateIdsResponse"
}
},
"icons": {
@@ -1314,17 +1306,25 @@
"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"
+ },
+ "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/"
+ "kind": "discovery#restDescription",
+ "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"
}
diff --git a/dialogflow/v2beta1/dialogflow-api.json b/dialogflow/v2beta1/dialogflow-api.json
index 1ba547d..1866467 100644
--- a/dialogflow/v2beta1/dialogflow-api.json
+++ b/dialogflow/v2beta1/dialogflow-api.json
@@ -1,1212 +1,30 @@
{
- "canonicalName": "Dialogflow",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://dialogflow.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "dialogflow",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Dialogflow API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "agent": {
- "methods": {
- "export": {
- "request": {
- "$ref": "ExportAgentRequest"
- },
- "description": "Exports the specified agent to a ZIP file.\n\n\nOperation \u003cresponse: ExportAgentResponse,\n metadata: google.protobuf.Struct\u003e",
- "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"
- },
- "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",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The project that the agent to restore 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:restore",
- "path": "v2beta1/{+parent}/agent:restore",
- "id": "dialogflow.projects.agent.restore"
- },
- "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"
- },
- "search": {
- "id": "dialogflow.projects.agent.search",
- "path": "v2beta1/{+parent}/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).",
- "httpMethod": "GET",
- "response": {
- "$ref": "SearchAgentsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "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"
- },
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The project to list agents from.\nFormat: `projects/\u003cProject ID or '-'\u003e`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent:search"
- },
- "train": {
- "path": "v2beta1/{+parent}/agent:train",
- "id": "dialogflow.projects.agent.train",
- "description": "Trains the specified agent.\n\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
- "request": {
- "$ref": "TrainAgentRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The project that the agent to train is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent:train"
- }
- },
- "resources": {
- "entityTypes": {
- "resources": {
- "entities": {
- "methods": {
- "batchUpdate": {
- "request": {
- "$ref": "BatchUpdateEntitiesRequest"
- },
- "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",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchUpdate",
- "path": "v2beta1/{+parent}/entities:batchUpdate",
- "id": "dialogflow.projects.agent.entityTypes.entities.batchUpdate"
- },
- "batchDelete": {
- "id": "dialogflow.projects.agent.entityTypes.entities.batchDelete",
- "path": "v2beta1/{+parent}/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",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$",
- "location": "path",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchDelete"
- },
- "batchCreate": {
- "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 create 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:batchCreate",
- "path": "v2beta1/{+parent}/entities:batchCreate",
- "id": "dialogflow.projects.agent.entityTypes.entities.batchCreate",
- "description": "Creates multiple new entities in the specified entity type (extends the\nexisting collection of entries).\n\nOperation \u003cresponse: google.protobuf.Empty\u003e",
- "request": {
- "$ref": "BatchCreateEntitiesRequest"
- }
- }
- }
- }
- },
- "methods": {
- "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"
- },
- "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"
- },
- "delete": {
- "description": "Deletes the specified entity type.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "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/[^/]+$",
- "location": "path"
- }
- },
- "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.",
- "response": {
- "$ref": "ListEntityTypesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "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"
- },
- "parent": {
- "pattern": "^projects/[^/]+/agent$",
- "location": "path",
- "description": "Required. The agent to list all entity types from.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
- "required": true,
- "type": "string"
- },
- "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",
- "path": "v2beta1/{+parent}/entityTypes",
- "id": "dialogflow.projects.agent.entityTypes.list"
- },
- "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"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes:batchDelete"
- },
- "create": {
- "request": {
- "$ref": "EntityType"
- },
- "description": "Creates an entity type in the specified agent.",
- "response": {
- "$ref": "EntityType"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes",
- "path": "v2beta1/{+parent}/entityTypes",
- "id": "dialogflow.projects.agent.entityTypes.create"
- },
- "patch": {
- "description": "Updates the specified entity type.",
- "request": {
- "$ref": "EntityType"
- },
- "response": {
- "$ref": "EntityType"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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": {
- "description": "Optional. The mask to control which fields get updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "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"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.entityTypes.patch"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "EntityType"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "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"
- },
- "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"
- }
- },
- "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."
- }
- }
- },
- "intents": {
- "methods": {
- "patch": {
- "response": {
- "$ref": "Intent"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.intents.patch",
- "description": "Updates the specified intent.",
- "request": {
- "$ref": "Intent"
- }
- },
- "get": {
- "response": {
- "$ref": "Intent"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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 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"
- },
- "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"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.intents.get",
- "description": "Retrieves the specified intent."
- },
- "batchUpdate": {
- "request": {
- "$ref": "BatchUpdateIntentsRequest"
- },
- "description": "Updates/Creates multiple intents in the specified agent.\n\nOperation \u003cresponse: BatchUpdateIntentsResponse\u003e",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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",
- "id": "dialogflow.projects.agent.intents.batchUpdate",
- "path": "v2beta1/{+parent}/intents:batchUpdate"
- },
- "delete": {
- "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": {
- "pattern": "^projects/[^/]+/agent/intents/[^/]+$",
- "location": "path",
- "description": "Required. The name of the intent to delete.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}"
- },
- "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": {
- "description": "Deletes intents in the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty\u003e",
- "request": {
- "$ref": "BatchDeleteIntentsRequest"
- },
- "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 delete all entities types for. Format:\n`projects/\u003cProject ID\u003e/agent`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent/intents:batchDelete",
- "path": "v2beta1/{+parent}/intents:batchDelete",
- "id": "dialogflow.projects.agent.intents.batchDelete"
- },
- "create": {
- "response": {
- "$ref": "Intent"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent/intents",
- "path": "v2beta1/{+parent}/intents",
- "id": "dialogflow.projects.agent.intents.create",
- "description": "Creates an intent in the specified agent.",
- "request": {
- "$ref": "Intent"
- }
- }
- }
- },
- "sessions": {
- "resources": {
- "entityTypes": {
- "methods": {
- "delete": {
- "description": "Deletes the specified session entity type.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.sessions.entityTypes.delete"
- },
- "list": {
- "response": {
- "$ref": "ListSessionEntityTypesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "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"
- },
- "parent": {
- "pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
- "location": "path",
- "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"
- }
- },
- "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."
- },
- "get": {
- "response": {
- "$ref": "SessionEntityType"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the session entity type. 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"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.sessions.entityTypes.get",
- "description": "Retrieves the specified session entity type."
- },
- "patch": {
- "id": "dialogflow.projects.agent.sessions.entityTypes.patch",
- "path": "v2beta1/{+name}",
- "request": {
- "$ref": "SessionEntityType"
- },
- "description": "Updates the specified session entity type.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "SessionEntityType"
- },
- "parameters": {
- "updateMask": {
- "description": "Optional. The mask to control which fields get updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}"
- },
- "create": {
- "response": {
- "$ref": "SessionEntityType"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "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/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes",
- "path": "v2beta1/{+parent}/entityTypes",
- "id": "dialogflow.projects.agent.sessions.entityTypes.create",
- "request": {
- "$ref": "SessionEntityType"
- },
- "description": "Creates a session entity type."
- }
- }
- },
- "contexts": {
- "methods": {
- "delete": {
- "id": "dialogflow.projects.agent.sessions.contexts.delete",
- "path": "v2beta1/{+name}",
- "description": "Deletes the specified context.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListContextsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The session to list all contexts from.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
- "location": "path"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts",
- "id": "dialogflow.projects.agent.sessions.contexts.list",
- "path": "v2beta1/{+parent}/contexts",
- "description": "Returns the list of all contexts in the specified session."
- },
- "get": {
- "response": {
- "$ref": "Context"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the context. 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.get",
- "description": "Retrieves the specified context."
- },
- "patch": {
- "response": {
- "$ref": "Context"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
- "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"
- },
- "updateMask": {
- "description": "Optional. The mask to control which fields get updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}",
- "path": "v2beta1/{+name}",
- "id": "dialogflow.projects.agent.sessions.contexts.patch",
- "request": {
- "$ref": "Context"
- },
- "description": "Updates the specified context."
- },
- "create": {
- "request": {
- "$ref": "Context"
- },
- "description": "Creates a context.",
- "response": {
- "$ref": "Context"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session to create a context for.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts",
- "path": "v2beta1/{+parent}/contexts",
- "id": "dialogflow.projects.agent.sessions.contexts.create"
- }
- }
- }
- },
- "methods": {
- "deleteContexts": {
- "id": "dialogflow.projects.agent.sessions.deleteContexts",
- "path": "v2beta1/{+parent}/contexts",
- "description": "Deletes all active contexts in the specified session.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "parent"
- ],
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts"
- },
- "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"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/agent",
- "path": "v2beta1/{+parent}/agent",
- "id": "dialogflow.projects.getAgent",
- "description": "Retrieves the specified agent."
- }
- }
- }
- },
"parameters": {
- "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\").",
+ "callback": {
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "JSONP"
},
"$.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": {
+ "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": [
@@ -1214,23 +32,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"
- },
- "access_token": {
- "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",
- "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.",
@@ -1238,31 +50,41 @@
"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": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
"default": "true",
"location": "query"
+ },
+ "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"
+ },
+ "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"
}
},
"version": "v2beta1",
@@ -1277,6 +99,164 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "BatchUpdateIntentsRequest": {
+ "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": {
+ "type": "string",
+ "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."
+ },
+ "updateMask": {
+ "description": "Optional. The mask to control which fields get updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "BatchUpdateIntentsRequest",
+ "description": "The request message for Intents.BatchUpdateIntents."
+ },
+ "TrainAgentRequest": {
+ "description": "The request message for Agents.TrainAgent.",
+ "type": "object",
+ "properties": {},
+ "id": "TrainAgentRequest"
+ },
+ "SessionEntityType": {
+ "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": {
+ "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"
+ ],
+ "description": "Required. Indicates whether the additional data should override or\nsupplement the developer entity type definition.",
+ "type": "string"
+ },
+ "entities": {
+ "description": "Required. The collection of entities associated with this session entity\ntype.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityTypeEntity"
+ }
+ }
+ },
+ "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"
+ },
+ "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"
+ },
+ "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": {
+ "type": "string",
+ "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."
+ },
+ "updateMask": {
+ "description": "Optional. The mask to control which fields get updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "BatchUpdateEntitiesRequest"
+ },
+ "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"
+ },
+ "WebhookResponse": {
+ "properties": {
+ "source": {
+ "type": "string",
+ "description": "Optional. This value is passed directly to `QueryResult.webhook_source`."
+ },
+ "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"
+ },
+ "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",
+ "description": "The response message for a webhook call.",
+ "type": "object"
+ },
"BatchDeleteIntentsRequest": {
"description": "The request message for Intents.BatchDeleteIntents.",
"type": "object",
@@ -1292,41 +272,32 @@
"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."
+ "description": "The event to be processed.",
+ "$ref": "EventInput"
},
"text": {
- "description": "The natural language text to be processed.",
- "$ref": "TextInput"
+ "$ref": "TextInput",
+ "description": "The natural language text to be processed."
},
"audioConfig": {
- "description": "Instructs the speech recognizer how to process the speech audio.",
- "$ref": "InputAudioConfig"
+ "$ref": "InputAudioConfig",
+ "description": "Instructs the speech recognizer how to process the speech audio."
}
},
- "id": "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"
- },
- "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"
+ "id": "QueryInput"
},
"DetectIntentResponse": {
+ "description": "The message returned from the DetectIntent method.",
+ "type": "object",
"properties": {
+ "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."
@@ -1334,15 +305,35 @@
"webhookStatus": {
"description": "Specifies the status of the webhook request. `webhook_status`\nis never populated in webhook requests.",
"$ref": "Status"
+ }
+ },
+ "id": "DetectIntentResponse"
+ },
+ "IntentFollowupIntentInfo": {
+ "description": "Represents a single followup intent in the chain.",
+ "type": "object",
+ "properties": {
+ "followupIntentName": {
+ "type": "string",
+ "description": "The unique identifier of the followup intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`."
},
- "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.",
+ "parentFollowupIntentName": {
+ "type": "string",
+ "description": "The unique identifier of the followup intent parent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`."
+ }
+ },
+ "id": "IntentFollowupIntentInfo"
+ },
+ "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": "DetectIntentResponse",
- "description": "The message returned from the DetectIntent method.",
- "type": "object"
+ "id": "ExportAgentRequest"
},
"IntentMessageLinkOutSuggestion": {
"description": "The suggestion chip message that allows the user to jump out to the app\nor website associated with this agent.",
@@ -1359,17 +350,6 @@
},
"id": "IntentMessageLinkOutSuggestion"
},
- "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"
- },
"IntentMessageSelectItemInfo": {
"properties": {
"synonyms": {
@@ -1389,18 +369,29 @@
"type": "object"
},
"Operation": {
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
"properties": {
+ "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": {
- "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"
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ }
},
"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`.",
@@ -1409,27 +400,14 @@
"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",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object"
+ }
},
"EventInput": {
- "description": "Events allow for matching intents by event name instead of the natural\nlanguage input. For instance, input `\u003cevent: { name: “welcome_event”,\nparameters: { name: “Sam” } }\u003e` can trigger a personalized welcome response.\nThe parameter `name` may be used by the agent in the response:\n`“Hello #welcome_event.name! What can I do for you today?”`.",
- "type": "object",
"properties": {
"name": {
- "description": "Required. The unique identifier of the event.",
- "type": "string"
+ "type": "string",
+ "description": "Required. The unique identifier of the event."
},
"parameters": {
"additionalProperties": {
@@ -1444,9 +422,12 @@
"type": "string"
}
},
- "id": "EventInput"
+ "id": "EventInput",
+ "description": "Events allow for matching intents by event name instead of the natural\nlanguage input. For instance, input `\u003cevent: { name: “welcome_event”,\nparameters: { name: “Sam” } }\u003e` can trigger a personalized welcome response.\nThe parameter `name` may be used by the agent in the response:\n`“Hello #welcome_event.name! What can I do for you today?”`.",
+ "type": "object"
},
"IntentMessageSuggestions": {
+ "type": "object",
"properties": {
"suggestions": {
"description": "Required. The list of suggested replies.",
@@ -1457,20 +438,12 @@
}
},
"id": "IntentMessageSuggestions",
- "description": "The collection of suggestions.",
- "type": "object"
+ "description": "The collection of suggestions."
},
"EntityType": {
"description": "Represents an entity type.\nEntity types serve as a tool for extracting parameter values from natural\nlanguage queries.",
"type": "object",
"properties": {
- "entities": {
- "description": "Optional. The collection of entities associated with the entity type.",
- "type": "array",
- "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"
@@ -1480,18 +453,18 @@
"type": "string"
},
"kind": {
+ "enumDescriptions": [
+ "Not specified. This value should be never used.",
+ "Map entity types allow mapping of a group of synonyms to a canonical\nvalue.",
+ "List entity types contain a set of entries that do not map to canonical\nvalues. However, list entity types can contain references to other entity\ntypes (with or without aliases)."
+ ],
"enum": [
"KIND_UNSPECIFIED",
"KIND_MAP",
"KIND_LIST"
],
"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.",
- "List entity types contain a set of entries that do not map to canonical\nvalues. However, list entity types can contain references to other entity\ntypes (with or without aliases)."
- ]
+ "type": "string"
},
"autoExpansionMode": {
"enumDescriptions": [
@@ -1504,6 +477,13 @@
],
"description": "Optional. Indicates whether the entity type can be automatically\nexpanded.",
"type": "string"
+ },
+ "entities": {
+ "description": "Optional. The collection of entities associated with the entity type.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityTypeEntity"
+ }
}
},
"id": "EntityType"
@@ -1512,25 +492,25 @@
"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"
- },
- "type": "object"
- }
+ }
+ },
+ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
},
"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"
@@ -1539,23 +519,33 @@
"description": "Corresponds to the `Response` field in API.AI console.",
"type": "object",
"properties": {
+ "simpleResponses": {
+ "description": "The voice and text-only responses for Actions on Google.",
+ "$ref": "IntentMessageSimpleResponses"
+ },
"image": {
"description": "The image response.",
"$ref": "IntentMessageImage"
},
"payload": {
+ "description": "The response containing a custom payload.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
- },
- "description": "The response containing a custom payload.",
- "type": "object"
+ }
},
"text": {
"$ref": "IntentMessageText",
"description": "The text response."
},
+ "suggestions": {
+ "$ref": "IntentMessageSuggestions",
+ "description": "The suggestion chips for Actions on Google."
+ },
"platform": {
+ "description": "Optional. The platform that this message is intended for.",
+ "type": "string",
"enumDescriptions": [
"Not specified.",
"Facebook.",
@@ -1577,102 +567,89 @@
"LINE",
"VIBER",
"ACTIONS_ON_GOOGLE"
- ],
- "description": "Optional. The platform that this message is intended for.",
- "type": "string"
- },
- "suggestions": {
- "description": "The suggestion chips for Actions on Google.",
- "$ref": "IntentMessageSuggestions"
+ ]
},
"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."
+ "description": "The quick replies response.",
+ "$ref": "IntentMessageQuickReplies"
},
"card": {
"$ref": "IntentMessageCard",
"description": "The card response."
},
"basicCard": {
- "$ref": "IntentMessageBasicCard",
- "description": "The basic card response for Actions on Google."
+ "description": "The basic card response for Actions on Google.",
+ "$ref": "IntentMessageBasicCard"
},
"carouselSelect": {
- "description": "The carousel card response for Actions on Google.",
- "$ref": "IntentMessageCarouselSelect"
+ "$ref": "IntentMessageCarouselSelect",
+ "description": "The carousel card response for Actions on Google."
},
"linkOutSuggestion": {
- "$ref": "IntentMessageLinkOutSuggestion",
- "description": "The link out suggestion chip for Actions on Google."
- },
- "simpleResponses": {
- "description": "The voice and text-only responses for Actions on Google.",
- "$ref": "IntentMessageSimpleResponses"
+ "description": "The link out suggestion chip for Actions on Google.",
+ "$ref": "IntentMessageLinkOutSuggestion"
}
},
"id": "IntentMessage"
},
"ListContextsResponse": {
+ "description": "The response message for Contexts.ListContexts.",
+ "type": "object",
"properties": {
- "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",
- "description": "The response message for Contexts.ListContexts.",
- "type": "object"
- },
- "OriginalDetectIntentRequest": {
- "description": "Represents the contents of the original request that was passed to\nthe `[Streaming]DetectIntent` call.",
- "type": "object",
- "properties": {
- "payload": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Optional. This field is set to the value of `QueryParameters.payload` field\npassed in the request.",
- "type": "object"
},
- "source": {
- "description": "The source of this request, e.g., `google`, `facebook`, `slack`. It is set\nby Dialogflow-owned servers. Possible values of this field correspond to\nIntent.Message.Platform.",
- "type": "string"
- }
- },
- "id": "OriginalDetectIntentRequest"
- },
- "EntityTypeBatch": {
- "description": "This message is a wrapper around a collection of entity types.",
- "type": "object",
- "properties": {
- "entityTypes": {
- "description": "A collection of entity types.",
+ "contexts": {
"type": "array",
"items": {
- "$ref": "EntityType"
- }
+ "$ref": "Context"
+ },
+ "description": "The list of contexts. There will be a maximum number of items\nreturned based on the page_size field in the request."
}
},
- "id": "EntityTypeBatch"
+ "id": "ListContextsResponse"
},
"Agent": {
+ "description": "Represents a conversational agent.",
+ "type": "object",
"properties": {
- "displayName": {
- "description": "Required. The name of this agent.",
+ "supportedLanguageCodes": {
+ "description": "Optional. The list of all languages supported by this agent (except for the\n`default_language_code`).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "enableLogging": {
+ "description": "Optional. Determines whether this agent should log conversation queries.",
+ "type": "boolean"
+ },
+ "avatarUri": {
+ "type": "string",
+ "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."
+ },
+ "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"
+ },
+ "defaultLanguageCode": {
+ "description": "Required. The default language of the agent as a language tag. See\n[Language Support](https://dialogflow.com/docs/reference/language) for a\nlist of the currently supported language codes.\nThis field cannot be set by the `Update` method.",
"type": "string"
},
+ "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"
+ },
+ "displayName": {
+ "type": "string",
+ "description": "Required. The name of this agent."
+ },
"description": {
"description": "Optional. The description of this agent.\nThe maximum length is 500 characters. If exceeded, the request is rejected.",
"type": "string"
@@ -1682,6 +659,8 @@
"type": "string"
},
"matchMode": {
+ "description": "Optional. Determines how intents are detected from user queries.",
+ "type": "string",
"enumDescriptions": [
"Not specified.",
"Best for agents with a small number of examples in intents and/or wide\nuse of templates syntax and composite entities.",
@@ -1691,57 +670,58 @@
"MATCH_MODE_UNSPECIFIED",
"MATCH_MODE_HYBRID",
"MATCH_MODE_ML_ONLY"
- ],
- "description": "Optional. Determines how intents are detected from user queries.",
- "type": "string"
- },
- "enableLogging": {
- "description": "Optional. Determines whether this agent should log conversation queries.",
- "type": "boolean"
- },
- "supportedLanguageCodes": {
- "description": "Optional. The list of all languages supported by this agent (except for the\n`default_language_code`).",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "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"
- },
- "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"
- },
- "defaultLanguageCode": {
- "description": "Required. The default language of the agent as a language tag. See\n[Language Support](https://dialogflow.com/docs/reference/language) for a\nlist of the currently supported language codes.\nThis field cannot be set by the `Update` method.",
- "type": "string"
+ ]
}
},
- "id": "Agent",
- "description": "Represents a conversational agent.",
+ "id": "Agent"
+ },
+ "EntityTypeBatch": {
+ "properties": {
+ "entityTypes": {
+ "description": "A collection of entity types.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityType"
+ }
+ }
+ },
+ "id": "EntityTypeBatch",
+ "description": "This message is a wrapper around a collection of entity types.",
"type": "object"
},
- "IntentMessageBasicCardButton": {
- "description": "The button object that appears at the bottom of a card.",
+ "OriginalDetectIntentRequest": {
+ "description": "Represents the contents of the original request that was passed to\nthe `[Streaming]DetectIntent` call.",
"type": "object",
"properties": {
- "openUriAction": {
- "$ref": "IntentMessageBasicCardButtonOpenUriAction",
- "description": "Required. Action to take when a user taps on the button."
+ "source": {
+ "description": "The source of this request, e.g., `google`, `facebook`, `slack`. It is set\nby Dialogflow-owned servers. Possible values of this field correspond to\nIntent.Message.Platform.",
+ "type": "string"
},
+ "payload": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Optional. This field is set to the value of `QueryParameters.payload` field\npassed in the request.",
+ "type": "object"
+ }
+ },
+ "id": "OriginalDetectIntentRequest"
+ },
+ "IntentMessageBasicCardButton": {
+ "properties": {
"title": {
"description": "Required. The title of the button.",
"type": "string"
+ },
+ "openUriAction": {
+ "description": "Required. Action to take when a user taps on the button.",
+ "$ref": "IntentMessageBasicCardButtonOpenUriAction"
}
},
- "id": "IntentMessageBasicCardButton"
+ "id": "IntentMessageBasicCardButton",
+ "description": "The button object that appears at the bottom of a card.",
+ "type": "object"
},
"IntentMessageSimpleResponse": {
"description": "The simple response message containing speech or text.",
@@ -1771,16 +751,16 @@
"type": "string"
},
"image": {
- "description": "Optional. The image to display.",
- "$ref": "IntentMessageImage"
+ "$ref": "IntentMessageImage",
+ "description": "Optional. The image to display."
},
"description": {
"description": "Optional. The main text describing the item.",
"type": "string"
},
"info": {
- "description": "Required. Additional information about this option.",
- "$ref": "IntentMessageSelectItemInfo"
+ "$ref": "IntentMessageSelectItemInfo",
+ "description": "Required. Additional information about this option."
}
},
"id": "IntentMessageListSelectItem"
@@ -1789,32 +769,50 @@
"description": "The basic card message. Useful for displaying information.",
"type": "object",
"properties": {
+ "subtitle": {
+ "type": "string",
+ "description": "Optional. The subtitle of the card."
+ },
"title": {
"description": "Optional. The title of the card.",
"type": "string"
},
"image": {
- "description": "Optional. The image for the card.",
- "$ref": "IntentMessageImage"
+ "$ref": "IntentMessageImage",
+ "description": "Optional. The image for the card."
},
"formattedText": {
- "description": "Required, unless image is present. The body text of the card.",
- "type": "string"
+ "type": "string",
+ "description": "Required, unless image is present. The body text of the card."
},
"buttons": {
- "description": "Optional. The collection of card buttons.",
"type": "array",
"items": {
"$ref": "IntentMessageBasicCardButton"
- }
- },
- "subtitle": {
- "description": "Optional. The subtitle of the card.",
- "type": "string"
+ },
+ "description": "Optional. The collection of card buttons."
}
},
"id": "IntentMessageBasicCard"
},
+ "EntityTypeEntity": {
+ "description": "Optional. Represents an entity.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "Required.\nFor `KIND_MAP` entity types:\n A canonical name to be used in place of synonyms.\nFor `KIND_LIST` entity types:\n A string that can contain references to other entity types (with or\n without aliases)."
+ },
+ "synonyms": {
+ "description": "Required. A collection of synonyms. For `KIND_LIST` entity types this\nmust contain exactly one synonym equal to `value`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "EntityTypeEntity"
+ },
"InputAudioConfig": {
"description": "Instructs the speech recognizer how to process the audio content.",
"type": "object",
@@ -1825,8 +823,8 @@
"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"
+ "type": "string",
+ "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."
},
"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.",
@@ -1862,63 +860,25 @@
},
"id": "InputAudioConfig"
},
- "EntityTypeEntity": {
- "description": "Optional. Represents an entity.",
+ "ListSessionEntityTypesResponse": {
"type": "object",
"properties": {
- "value": {
- "description": "Required.\nFor `KIND_MAP` entity types:\n A canonical name to be used in place of synonyms.\nFor `KIND_LIST` entity types:\n A string that can contain references to other entity types (with or\n without aliases).",
- "type": "string"
- },
- "synonyms": {
- "description": "Required. A collection of synonyms. For `KIND_LIST` entity types this\nmust contain exactly one synonym equal to `value`.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "EntityTypeEntity"
- },
- "ListSessionEntityTypesResponse": {
- "properties": {
- "nextPageToken": {
- "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
- "type": "string"
- },
"sessionEntityTypes": {
"description": "The list of session entity types. There will be a maximum number of items\nreturned based on the page_size field in the request.",
"type": "array",
"items": {
"$ref": "SessionEntityType"
}
- }
- },
- "id": "ListSessionEntityTypesResponse",
- "description": "The response message for SessionEntityTypes.ListSessionEntityTypes.",
- "type": "object"
- },
- "SearchAgentsResponse": {
- "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.",
- "type": "array",
- "items": {
- "$ref": "Agent"
- }
},
"nextPageToken": {
"description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
"type": "string"
}
},
- "id": "SearchAgentsResponse",
- "description": "The response message for Agents.SearchAgents.",
- "type": "object"
+ "id": "ListSessionEntityTypesResponse",
+ "description": "The response message for SessionEntityTypes.ListSessionEntityTypes."
},
"IntentMessageCarouselSelect": {
- "description": "The card for presenting a carousel of options to select from.",
- "type": "object",
"properties": {
"items": {
"description": "Required. Carousel items.",
@@ -1928,9 +888,46 @@
}
}
},
- "id": "IntentMessageCarouselSelect"
+ "id": "IntentMessageCarouselSelect",
+ "description": "The card for presenting a carousel of options to select from.",
+ "type": "object"
+ },
+ "SearchAgentsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.",
+ "type": "string"
+ },
+ "agents": {
+ "description": "The list of agents. There will be a maximum number of items returned based\non the page_size field in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Agent"
+ }
+ }
+ },
+ "id": "SearchAgentsResponse",
+ "description": "The response message for Agents.SearchAgents.",
+ "type": "object"
+ },
+ "IntentMessageSimpleResponses": {
+ "id": "IntentMessageSimpleResponses",
+ "description": "The collection of simple response candidates.\nThis message in `QueryResult.fulfillment_messages` and\n`WebhookResponse.fulfillment_messages` should contain only one\n`SimpleResponse`.",
+ "type": "object",
+ "properties": {
+ "simpleResponses": {
+ "description": "Required. The list of simple responses.",
+ "type": "array",
+ "items": {
+ "$ref": "IntentMessageSimpleResponse"
+ }
+ }
+ }
},
"BatchCreateEntitiesRequest": {
+ "id": "BatchCreateEntitiesRequest",
+ "description": "The request message for EntityTypes.BatchCreateEntities.",
+ "type": "object",
"properties": {
"entities": {
"description": "Required. The collection of entities to create.",
@@ -1943,26 +940,31 @@
"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"
}
- },
- "id": "BatchCreateEntitiesRequest",
- "description": "The request message for EntityTypes.BatchCreateEntities.",
- "type": "object"
+ }
},
- "IntentMessageSimpleResponses": {
+ "DetectIntentRequest": {
+ "description": "The request to detect user's intent.",
+ "type": "object",
"properties": {
- "simpleResponses": {
- "description": "Required. The list of simple responses.",
- "type": "array",
- "items": {
- "$ref": "IntentMessageSimpleResponse"
- }
+ "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.",
+ "$ref": "QueryInput"
+ },
+ "queryParams": {
+ "$ref": "QueryParameters",
+ "description": "Optional. The parameters of this query."
+ },
+ "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.",
+ "format": "byte",
+ "type": "string"
}
},
- "id": "IntentMessageSimpleResponses",
- "description": "The collection of simple response candidates.\nThis message in `QueryResult.fulfillment_messages` and\n`WebhookResponse.fulfillment_messages` should contain only one\n`SimpleResponse`.",
- "type": "object"
+ "id": "DetectIntentRequest"
},
"TextInput": {
+ "description": "Represents the natural language text to be processed.",
+ "type": "object",
"properties": {
"languageCode": {
"description": "Required. The language of this conversational 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.",
@@ -1973,46 +975,26 @@
"type": "string"
}
},
- "id": "TextInput",
- "description": "Represents the natural language text to be processed.",
- "type": "object"
- },
- "DetectIntentRequest": {
- "properties": {
- "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."
- },
- "queryParams": {
- "description": "Optional. The parameters of this query.",
- "$ref": "QueryParameters"
- },
- "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.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "DetectIntentRequest",
- "description": "The request to detect user's intent.",
- "type": "object"
+ "id": "TextInput"
},
"IntentMessageCardButton": {
+ "id": "IntentMessageCardButton",
"description": "Optional. Contains information about a button.",
"type": "object",
"properties": {
- "postback": {
- "description": "Optional. The text to send back to the Dialogflow API or a URI to\nopen.",
- "type": "string"
- },
"text": {
"description": "Optional. The text to show on the button.",
"type": "string"
+ },
+ "postback": {
+ "description": "Optional. The text to send back to the Dialogflow API or a URI to\nopen.",
+ "type": "string"
}
- },
- "id": "IntentMessageCardButton"
+ }
},
"ListEntityTypesResponse": {
+ "description": "The response message for EntityTypes.ListEntityTypes.",
+ "type": "object",
"properties": {
"entityTypes": {
"description": "The list of agent entity types. There will be a maximum number of items\nreturned based on the page_size field in the request.",
@@ -2026,31 +1008,13 @@
"type": "string"
}
},
- "id": "ListEntityTypesResponse",
- "description": "The response message for EntityTypes.ListEntityTypes.",
- "type": "object"
+ "id": "ListEntityTypesResponse"
},
"QueryResult": {
+ "id": "QueryResult",
+ "description": "Represents the result of conversational query or event processing.",
+ "type": "object",
"properties": {
- "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"
- },
- "fulfillmentMessages": {
- "description": "The collection of rich messages to present to the user.",
- "type": "array",
- "items": {
- "$ref": "IntentMessage"
- }
- },
- "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"
@@ -2076,15 +1040,15 @@
"description": "This field is set to:\n- `false` if the matched intent has required parameters and not all of\n the required parameter values have been collected.\n- `true` if all required parameter values have been collected, or if the\n matched intent doesn't contain any required parameters.",
"type": "boolean"
},
- "speechRecognitionConfidence": {
- "description": "The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. The default of 0.0 is a sentinel value indicating that confidence\nwas not set. This field is populated if natural speech audio was provided\nas input.",
- "format": "float",
- "type": "number"
- },
"queryText": {
"description": "The original conversational query text:\n- If natural language text was provided as input, `query_text` contains\n a copy of the input.\n- If natural language speech audio was provided as input, `query_text`\n contains the speech recognition result. If speech recognizer produced\n multiple alternatives, a particular one is picked.\n- If an event was provided as input, `query_text` is not set.",
"type": "string"
},
+ "speechRecognitionConfidence": {
+ "type": "number",
+ "description": "The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. The default of 0.0 is a sentinel value indicating that confidence\nwas not set. This field is populated if natural speech audio was provided\nas input.",
+ "format": "float"
+ },
"diagnosticInfo": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -2094,11 +1058,11 @@
"type": "object"
},
"outputContexts": {
- "description": "The collection of output contexts. If applicable,\n`output_contexts.parameters` contains entries with name\n`\u003cparameter name\u003e.original` containing the original parameter values\nbefore the query.",
"type": "array",
"items": {
"$ref": "Context"
- }
+ },
+ "description": "The collection of output contexts. If applicable,\n`output_contexts.parameters` contains entries with name\n`\u003cparameter name\u003e.original` containing the original parameter values\nbefore the query."
},
"languageCode": {
"description": "The language that was triggered during intent detection.\nSee [Language Support](https://dialogflow.com/docs/reference/language)\nfor a list of the currently supported language codes.",
@@ -2107,13 +1071,31 @@
"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": {
+ "type": "object",
+ "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."
+ },
+ "action": {
+ "description": "The action name from the matched intent.",
+ "type": "string"
}
- },
- "id": "QueryResult",
- "description": "Represents the result of conversational query or event processing.",
- "type": "object"
+ }
},
"BatchDeleteEntityTypesRequest": {
+ "description": "The request message for EntityTypes.BatchDeleteEntityTypes.",
+ "type": "object",
"properties": {
"entityTypeNames": {
"description": "Required. The names entity types to delete. All names must point to the\nsame agent as `parent`.",
@@ -2123,11 +1105,11 @@
}
}
},
- "id": "BatchDeleteEntityTypesRequest",
- "description": "The request message for EntityTypes.BatchDeleteEntityTypes.",
- "type": "object"
+ "id": "BatchDeleteEntityTypesRequest"
},
"BatchUpdateEntityTypesResponse": {
+ "description": "The response message for EntityTypes.BatchUpdateEntityTypes.",
+ "type": "object",
"properties": {
"entityTypes": {
"description": "The collection of updated or created entity types.",
@@ -2137,19 +1119,12 @@
}
}
},
- "id": "BatchUpdateEntityTypesResponse",
- "description": "The response message for EntityTypes.BatchUpdateEntityTypes.",
- "type": "object"
+ "id": "BatchUpdateEntityTypesResponse"
},
"IntentMessageCard": {
+ "description": "The card response message.",
+ "type": "object",
"properties": {
- "buttons": {
- "description": "Optional. The collection of card buttons.",
- "type": "array",
- "items": {
- "$ref": "IntentMessageCardButton"
- }
- },
"subtitle": {
"description": "Optional. The subtitle of the card.",
"type": "string"
@@ -2161,20 +1136,24 @@
"title": {
"description": "Optional. The title of the card.",
"type": "string"
- }
- },
- "id": "IntentMessageCard",
- "description": "The card response message.",
- "type": "object"
- },
- "QueryParameters": {
- "properties": {
- "sessionEntityTypes": {
- "description": "Optional. The collection of session entity types to replace or extend\ndeveloper entities with for this query only. The entity synonyms apply\nto all languages.",
+ },
+ "buttons": {
+ "description": "Optional. The collection of card buttons.",
"type": "array",
"items": {
- "$ref": "SessionEntityType"
+ "$ref": "IntentMessageCardButton"
}
+ }
+ },
+ "id": "IntentMessageCard"
+ },
+ "QueryParameters": {
+ "description": "Represents the parameters of the conversational query.",
+ "type": "object",
+ "properties": {
+ "resetContexts": {
+ "description": "Optional. Specifies whether to delete all contexts in the current session\nbefore the new ones are activated.",
+ "type": "boolean"
},
"payload": {
"additionalProperties": {
@@ -2188,10 +1167,6 @@
"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.",
- "type": "boolean"
- },
"contexts": {
"description": "Optional. The collection of contexts to be activated before this query is\nexecuted.",
"type": "array",
@@ -2202,131 +1177,21 @@
"timeZone": {
"description": "Optional. The time zone of this conversational query from the\n[time zone database](https://www.iana.org/time-zones), e.g.,\nAmerica/New_York, Europe/Paris. If not provided, the time zone specified in\nagent settings is used.",
"type": "string"
+ },
+ "sessionEntityTypes": {
+ "description": "Optional. The collection of session entity types to replace or extend\ndeveloper entities with for this query only. The entity synonyms apply\nto all languages.",
+ "type": "array",
+ "items": {
+ "$ref": "SessionEntityType"
+ }
}
},
- "id": "QueryParameters",
- "description": "Represents the parameters of the conversational query.",
- "type": "object"
- },
- "BatchUpdateEntityTypesRequest": {
- "description": "The request message for EntityTypes.BatchUpdateEntityTypes.",
- "type": "object",
- "properties": {
- "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"
- },
- "updateMask": {
- "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": {
- "description": "The collection of entity type to update or create.",
- "$ref": "EntityTypeBatch"
- }
- },
- "id": "BatchUpdateEntityTypesRequest"
+ "id": "QueryParameters"
},
"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": {
- "outputContexts": {
- "description": "Optional. The collection of contexts that are activated when the intent\nis matched. Context messages in this collection should not set the\nparameters field. Setting the `lifespan_count` to 0 will reset the context\nwhen the intent is matched.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/-/contexts/\u003cContext ID\u003e`.",
- "type": "array",
- "items": {
- "$ref": "Context"
- }
- },
- "defaultResponsePlatforms": {
- "description": "Optional. The list of platforms for which the first response will be\ntaken from among the messages assigned to the DEFAULT_PLATFORM.",
- "type": "array",
- "items": {
- "enum": [
- "PLATFORM_UNSPECIFIED",
- "FACEBOOK",
- "SLACK",
- "TELEGRAM",
- "KIK",
- "SKYPE",
- "LINE",
- "VIBER",
- "ACTIONS_ON_GOOGLE"
- ],
- "type": "string"
- },
- "enumDescriptions": [
- "Not specified.",
- "Facebook.",
- "Slack.",
- "Telegram.",
- "Kik.",
- "Skype.",
- "Line.",
- "Viber.",
- "Actions on Google."
- ]
- },
- "action": {
- "description": "Optional. The name of the action associated with the intent.",
- "type": "string"
- },
- "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`.",
- "type": "string"
- },
- "messages": {
- "description": "Optional. The collection of rich messages corresponding to the\n`Response` field in API.AI console.",
- "type": "array",
- "items": {
- "$ref": "IntentMessage"
- }
- },
- "webhookState": {
- "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"
- ],
- "description": "Required. Indicates whether webhooks are enabled for the intent.",
- "type": "string"
- },
- "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"
- }
- },
- "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"
- },
- "displayName": {
- "description": "Required. The name of this intent.",
- "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"
@@ -2349,6 +1214,10 @@
"$ref": "IntentParameter"
}
},
+ "parentFollowupIntentName": {
+ "description": "The unique identifier of the parent intent in the chain of followup\nintents.\nIt identifies the parent followup intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
+ "type": "string"
+ },
"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",
@@ -2356,19 +1225,154 @@
"type": "string"
}
},
- "parentFollowupIntentName": {
- "description": "The unique identifier of the parent intent in the chain of followup\nintents.\nIt identifies the parent followup intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
- "type": "string"
- },
"priority": {
"description": "Optional. The priority of this intent. Higher numbers represent higher\npriorities. Zero or negative numbers mean that the intent is disabled.",
"format": "int32",
"type": "integer"
+ },
+ "outputContexts": {
+ "description": "Optional. The collection of contexts that are activated when the intent\nis matched. Context messages in this collection should not set the\nparameters field. Setting the `lifespan_count` to 0 will reset the context\nwhen the intent is matched.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/-/contexts/\u003cContext ID\u003e`.",
+ "type": "array",
+ "items": {
+ "$ref": "Context"
+ }
+ },
+ "defaultResponsePlatforms": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Facebook.",
+ "Slack.",
+ "Telegram.",
+ "Kik.",
+ "Skype.",
+ "Line.",
+ "Viber.",
+ "Actions on Google."
+ ],
+ "description": "Optional. The list of platforms for which the first response will be\ntaken from among the messages assigned to the DEFAULT_PLATFORM.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "PLATFORM_UNSPECIFIED",
+ "FACEBOOK",
+ "SLACK",
+ "TELEGRAM",
+ "KIK",
+ "SKYPE",
+ "LINE",
+ "VIBER",
+ "ACTIONS_ON_GOOGLE"
+ ],
+ "type": "string"
+ }
+ },
+ "action": {
+ "description": "Optional. The name of the action associated with the intent.",
+ "type": "string"
+ },
+ "messages": {
+ "description": "Optional. The collection of rich messages corresponding to the\n`Response` field in API.AI console.",
+ "type": "array",
+ "items": {
+ "$ref": "IntentMessage"
+ }
+ },
+ "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`.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "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"
+ ]
+ },
+ "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": {
+ "type": "boolean",
+ "description": "Optional. Indicates whether this is a fallback intent."
}
},
"id": "Intent"
},
+ "BatchUpdateEntityTypesRequest": {
+ "description": "The request message for EntityTypes.BatchUpdateEntityTypes.",
+ "type": "object",
+ "properties": {
+ "entityTypeBatchUri": {
+ "type": "string",
+ "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://\"."
+ },
+ "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"
+ },
+ "updateMask": {
+ "description": "Optional. The mask to control which fields get updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "BatchUpdateEntityTypesRequest"
+ },
+ "IntentTrainingPhrasePart": {
+ "description": "Represents a part of a training phrase.",
+ "type": "object",
+ "properties": {
+ "alias": {
+ "description": "Optional. The parameter name for the value extracted from the\nannotated part of the example.",
+ "type": "string"
+ },
+ "userDefined": {
+ "description": "Optional. Indicates whether the text was manually annotated by the\ndeveloper.",
+ "type": "boolean"
+ },
+ "text": {
+ "type": "string",
+ "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."
+ },
+ "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"
+ },
"IntentBatch": {
+ "id": "IntentBatch",
"description": "This message is a wrapper around a collection of intents.",
"type": "object",
"properties": {
@@ -2379,33 +1383,11 @@
"$ref": "Intent"
}
}
- },
- "id": "IntentBatch"
- },
- "IntentTrainingPhrasePart": {
- "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"
- },
- "userDefined": {
- "description": "Optional. Indicates whether the text was manually annotated by the\ndeveloper.",
- "type": "boolean"
- },
- "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"
- }
- },
- "id": "IntentTrainingPhrasePart",
- "description": "Represents a part of a training phrase.",
- "type": "object"
+ }
},
"BatchDeleteEntitiesRequest": {
+ "description": "The request message for EntityTypes.BatchDeleteEntities.",
+ "type": "object",
"properties": {
"entityValues": {
"description": "Required. The canonical `values` of the entities to delete. Note that\nthese are not fully-qualified names, i.e. they don't start with\n`projects/\u003cProject ID\u003e`.",
@@ -2419,17 +1401,13 @@
"type": "string"
}
},
- "id": "BatchDeleteEntitiesRequest",
- "description": "The request message for EntityTypes.BatchDeleteEntities.",
- "type": "object"
+ "id": "BatchDeleteEntitiesRequest"
},
"IntentMessageListSelect": {
- "description": "The card for presenting a list of options to select from.",
- "type": "object",
"properties": {
"title": {
- "description": "Optional. The overall title of the list.",
- "type": "string"
+ "type": "string",
+ "description": "Optional. The overall title of the list."
},
"items": {
"description": "Required. List items.",
@@ -2439,79 +1417,81 @@
}
}
},
- "id": "IntentMessageListSelect"
+ "id": "IntentMessageListSelect",
+ "description": "The card for presenting a list of options to select from.",
+ "type": "object"
},
"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": {
+ "id": "IntentMessageCarouselSelectItem",
"description": "An item in the carousel.",
"type": "object",
"properties": {
- "title": {
- "description": "Required. Title of the carousel item.",
- "type": "string"
- },
- "image": {
- "description": "Optional. The image to display.",
- "$ref": "IntentMessageImage"
- },
"description": {
"description": "Optional. The body text of the card.",
"type": "string"
},
"info": {
- "description": "Required. Additional info about the option item.",
- "$ref": "IntentMessageSelectItemInfo"
+ "$ref": "IntentMessageSelectItemInfo",
+ "description": "Required. Additional info about the option item."
+ },
+ "title": {
+ "description": "Required. Title of the carousel item.",
+ "type": "string"
+ },
+ "image": {
+ "$ref": "IntentMessageImage",
+ "description": "Optional. The image to display."
}
- },
- "id": "IntentMessageCarouselSelectItem"
+ }
},
"IntentMessageQuickReplies": {
+ "description": "The quick replies response message.",
+ "type": "object",
"properties": {
+ "title": {
+ "type": "string",
+ "description": "Optional. The title of the collection of quick replies."
+ },
"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",
- "description": "The quick replies response message.",
- "type": "object"
+ "id": "IntentMessageQuickReplies"
},
"WebhookRequest": {
"description": "The request message for a webhook call.",
"type": "object",
"properties": {
+ "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"
},
"queryResult": {
- "$ref": "QueryResult",
- "description": "The result of the conversational query or event processing. Contains the\nsame value as `[Streaming]DetectIntentResponse.query_result`."
+ "description": "The result of the conversational query or event processing. Contains the\nsame value as `[Streaming]DetectIntentResponse.query_result`.",
+ "$ref": "QueryResult"
},
"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"
+ "description": "Optional. The contents of the original request that was passed to\n`[Streaming]DetectIntent` call.",
+ "$ref": "OriginalDetectIntentRequest"
}
},
"id": "WebhookRequest"
@@ -2534,6 +1514,20 @@
},
"IntentTrainingPhrase": {
"properties": {
+ "type": {
+ "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"
+ ],
+ "description": "Required. The type of the training phrase."
+ },
"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",
@@ -2549,20 +1543,6 @@
"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."
- ]
}
},
"id": "IntentTrainingPhrase",
@@ -2570,6 +1550,8 @@
"type": "object"
},
"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.",
@@ -2583,31 +1565,34 @@
"type": "string"
}
},
- "id": "ListIntentsResponse",
- "description": "The response message for Intents.ListIntents.",
- "type": "object"
+ "id": "ListIntentsResponse"
},
"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": {
- "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": {
+ "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"
@@ -2619,16 +1604,13 @@
},
"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"
- },
- "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"
}
},
"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 -H \"Authorization: Bearer \"$(gcloud auth print-access-token) \\\n -H \"Content-Type: application/json; charset=utf-8\" \\\n --data \"{\n 'agentContent': '$(cat \u003cagent zip file\u003e | base64 -w 0)'\n}\" \\\n\"https://dialogflow.googleapis.com/v2beta1/projects/\u003cproject_name\u003e/agent:import\"",
@@ -2640,9 +1622,7 @@
"type": "string"
}
},
- "id": "ImportAgentRequest",
- "description": "The request message for Agents.ImportAgent.",
- "type": "object"
+ "id": "ImportAgentRequest"
},
"BatchUpdateIntentsResponse": {
"description": "The response message for Intents.BatchUpdateIntents.",
@@ -2659,7 +1639,13 @@
"id": "BatchUpdateIntentsResponse"
},
"IntentParameter": {
+ "description": "Represents intent parameters.",
+ "type": "object",
"properties": {
+ "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"
@@ -2683,22 +1669,16 @@
"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"
},
- "isList": {
- "description": "Optional. Indicates whether the parameter represents a list of values.",
- "type": "boolean"
- },
"name": {
"description": "The unique identifier of this parameter.",
"type": "string"
},
- "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"
+ "isList": {
+ "description": "Optional. Indicates whether the parameter represents a list of values.",
+ "type": "boolean"
}
},
- "id": "IntentParameter",
- "description": "Represents intent parameters.",
- "type": "object"
+ "id": "IntentParameter"
},
"ExportAgentResponse": {
"description": "The response message for Agents.ExportAgent.",
@@ -2717,6 +1697,7 @@
"id": "ExportAgentResponse"
},
"IntentMessageBasicCardButtonOpenUriAction": {
+ "id": "IntentMessageBasicCardButtonOpenUriAction",
"description": "Opens the given URI.",
"type": "object",
"properties": {
@@ -2724,182 +1705,1201 @@
"description": "Required. The HTTP or HTTPS scheme URI.",
"type": "string"
}
- },
- "id": "IntentMessageBasicCardButtonOpenUriAction"
+ }
},
"IntentMessageImage": {
+ "id": "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": {
- "enum": [
- "INTENT_VIEW_UNSPECIFIED",
- "INTENT_VIEW_FULL"
- ],
- "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."
- ]
- },
- "intentBatchInline": {
- "$ref": "IntentBatch",
- "description": "The collection of intents to update or create."
- },
- "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"
+ "description": "Optional. The public URI to an image file."
}
- },
- "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": {
- "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"
- },
- "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."
- ]
- }
- },
- "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": {
- "properties": {
- "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"
- },
- "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"
- },
- "source": {
- "description": "Optional. This value is passed directly to `QueryResult.webhook_source`.",
- "type": "string"
- }
- },
- "id": "WebhookResponse",
- "description": "The response message for a webhook call.",
- "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": "Dialogflow",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://dialogflow.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "dialogflow",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Dialogflow API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "methods": {
+ "getAgent": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Agent"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The project that the agent to fetch 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",
+ "id": "dialogflow.projects.getAgent",
+ "path": "v2beta1/{+parent}/agent",
+ "description": "Retrieves the specified agent."
+ }
+ },
+ "resources": {
+ "agent": {
+ "methods": {
+ "export": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The project that the agent to export is associated with.\nFormat: `projects/\u003cProject ID\u003e`."
+ }
+ },
+ "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": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The project that the agent to restore is associated with.\nFormat: `projects/\u003cProject ID\u003e`."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent:restore",
+ "id": "dialogflow.projects.agent.restore",
+ "path": "v2beta1/{+parent}/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",
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The project that the agent to import 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:import",
+ "path": "v2beta1/{+parent}/agent:import",
+ "id": "dialogflow.projects.agent.import",
+ "request": {
+ "$ref": "ImportAgentRequest"
+ },
+ "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"
+ },
+ "search": {
+ "flatPath": "v2beta1/projects/{projectsId}/agent:search",
+ "id": "dialogflow.projects.agent.search",
+ "path": "v2beta1/{+parent}/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).",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "SearchAgentsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "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": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The project to list agents from.\nFormat: `projects/\u003cProject ID or '-'\u003e`."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "train": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The project that the agent to train is associated with.\nFormat: `projects/\u003cProject ID\u003e`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent:train",
+ "path": "v2beta1/{+parent}/agent:train",
+ "id": "dialogflow.projects.agent.train",
+ "description": "Trains the specified agent.\n\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
+ "request": {
+ "$ref": "TrainAgentRequest"
+ }
+ }
+ },
+ "resources": {
+ "entityTypes": {
+ "methods": {
+ "batchDelete": {
+ "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",
+ "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"
+ },
+ "create": {
+ "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": {
+ "pattern": "^projects/[^/]+/agent$",
+ "location": "path",
+ "description": "Required. The agent to create a entity type for.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ },
+ "patch": {
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.agent.entityTypes.patch",
+ "description": "Updates the specified entity type.",
+ "request": {
+ "$ref": "EntityType"
+ },
+ "response": {
+ "$ref": "EntityType"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "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",
+ "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}"
+ },
+ "get": {
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.agent.entityTypes.get",
+ "description": "Retrieves the specified entity type.",
+ "response": {
+ "$ref": "EntityType"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}"
+ },
+ "batchUpdate": {
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes:batchUpdate",
+ "id": "dialogflow.projects.agent.entityTypes.batchUpdate",
+ "path": "v2beta1/{+parent}/entityTypes:batchUpdate",
+ "request": {
+ "$ref": "BatchUpdateEntityTypesRequest"
+ },
+ "description": "Updates/Creates multiple entity types in the specified agent.\n\nOperation \u003cresponse: BatchUpdateEntityTypesResponse,\n metadata: google.protobuf.Struct\u003e",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "delete": {
+ "description": "Deletes the specified entity type.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "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}",
+ "id": "dialogflow.projects.agent.entityTypes.delete",
+ "path": "v2beta1/{+name}"
+ },
+ "list": {
+ "description": "Returns the list of all entity types in the specified agent.",
+ "response": {
+ "$ref": "ListEntityTypesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/agent$",
+ "location": "path",
+ "description": "Required. The agent to list all entity types from.\nFormat: `projects/\u003cProject ID\u003e/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"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes",
+ "path": "v2beta1/{+parent}/entityTypes",
+ "id": "dialogflow.projects.agent.entityTypes.list"
+ }
+ },
+ "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": {
+ "path": "v2beta1/{+parent}/entities:batchDelete",
+ "id": "dialogflow.projects.agent.entityTypes.entities.batchDelete",
+ "description": "Deletes entities in the specified entity type.\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e",
+ "request": {
+ "$ref": "BatchDeleteEntitiesRequest"
+ },
+ "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 delete entries for. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchDelete"
+ },
+ "batchCreate": {
+ "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 create 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:batchCreate",
+ "path": "v2beta1/{+parent}/entities:batchCreate",
+ "id": "dialogflow.projects.agent.entityTypes.entities.batchCreate",
+ "description": "Creates multiple new entities in the specified entity type (extends the\nexisting collection of entries).\n\nOperation \u003cresponse: google.protobuf.Empty\u003e",
+ "request": {
+ "$ref": "BatchCreateEntitiesRequest"
+ }
+ }
+ }
+ }
+ }
+ },
+ "intents": {
+ "methods": {
+ "get": {
+ "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}",
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.agent.intents.get",
+ "description": "Retrieves the specified intent.",
+ "response": {
+ "$ref": "Intent"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/agent/intents/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.",
+ "required": true,
+ "type": "string"
+ },
+ "intentView": {
+ "description": "Optional. The resource view to apply to the returned intent.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "INTENT_VIEW_UNSPECIFIED",
+ "INTENT_VIEW_FULL"
+ ]
+ },
+ "languageCode": {
+ "location": "query",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "patch": {
+ "request": {
+ "$ref": "Intent"
+ },
+ "description": "Updates the specified intent.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Intent"
+ },
+ "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": {
+ "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"
+ },
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional. The mask to control which fields get updated.",
+ "format": "google-fieldmask"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/agent/intents/[^/]+$",
+ "location": "path",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}",
+ "id": "dialogflow.projects.agent.intents.patch",
+ "path": "v2beta1/{+name}"
+ },
+ "batchUpdate": {
+ "flatPath": "v2beta1/projects/{projectsId}/agent/intents:batchUpdate",
+ "path": "v2beta1/{+parent}/intents:batchUpdate",
+ "id": "dialogflow.projects.agent.intents.batchUpdate",
+ "description": "Updates/Creates multiple intents in the specified agent.\n\nOperation \u003cresponse: BatchUpdateIntentsResponse\u003e",
+ "request": {
+ "$ref": "BatchUpdateIntentsRequest"
+ },
+ "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 intents in.\nFormat: `projects/\u003cProject ID\u003e/agent`.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}",
+ "id": "dialogflow.projects.agent.intents.delete",
+ "path": "v2beta1/{+name}",
+ "description": "Deletes the specified intent."
+ },
+ "list": {
+ "description": "Returns the list of all intents in the specified agent.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListIntentsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "intentView": {
+ "location": "query",
+ "enum": [
+ "INTENT_VIEW_UNSPECIFIED",
+ "INTENT_VIEW_FULL"
+ ],
+ "description": "Optional. The resource view to apply to the returned intent.",
+ "type": "string"
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/intents",
+ "id": "dialogflow.projects.agent.intents.list",
+ "path": "v2beta1/{+parent}/intents"
+ },
+ "batchDelete": {
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "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`."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/intents:batchDelete",
+ "path": "v2beta1/{+parent}/intents:batchDelete",
+ "id": "dialogflow.projects.agent.intents.batchDelete",
+ "request": {
+ "$ref": "BatchDeleteIntentsRequest"
+ },
+ "description": "Deletes intents in the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty\u003e",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Intent"
+ },
+ "parameters": {
+ "languageCode": {
+ "type": "string",
+ "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."
+ },
+ "intentView": {
+ "description": "Optional. The resource view to apply to the returned intent.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "INTENT_VIEW_UNSPECIFIED",
+ "INTENT_VIEW_FULL"
+ ]
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/intents",
+ "id": "dialogflow.projects.agent.intents.create",
+ "path": "v2beta1/{+parent}/intents",
+ "request": {
+ "$ref": "Intent"
+ },
+ "description": "Creates an intent in the specified agent."
+ }
+ }
+ },
+ "sessions": {
+ "methods": {
+ "deleteContexts": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "parent": {
+ "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",
+ "pattern": "^projects/[^/]+/agent/sessions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": {
+ "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"
+ },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "session": {
+ "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",
+ "pattern": "^projects/[^/]+/agent/sessions/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}:detectIntent",
+ "path": "v2beta1/{+session}:detectIntent",
+ "id": "dialogflow.projects.agent.sessions.detectIntent"
+ }
+ },
+ "resources": {
+ "contexts": {
+ "methods": {
+ "list": {
+ "description": "Returns the list of all contexts in the specified session.",
+ "response": {
+ "$ref": "ListContextsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The session to list all contexts from.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/agent/sessions/[^/]+$"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts",
+ "path": "v2beta1/{+parent}/contexts",
+ "id": "dialogflow.projects.agent.sessions.contexts.list"
+ },
+ "get": {
+ "response": {
+ "$ref": "Context"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the context. 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.get",
+ "description": "Retrieves the specified context."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Context"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
+ "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"
+ },
+ "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/sessions/{sessionsId}/contexts/{contextsId}",
+ "id": "dialogflow.projects.agent.sessions.contexts.patch",
+ "path": "v2beta1/{+name}",
+ "request": {
+ "$ref": "Context"
+ },
+ "description": "Updates the specified context."
+ },
+ "create": {
+ "description": "Creates a context.",
+ "request": {
+ "$ref": "Context"
+ },
+ "response": {
+ "$ref": "Context"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/agent/sessions/[^/]+$",
+ "location": "path",
+ "description": "Required. The session to create a context for.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the context to delete. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`."
+ }
+ }
+ }
+ }
+ },
+ "entityTypes": {
+ "methods": {
+ "create": {
+ "id": "dialogflow.projects.agent.sessions.entityTypes.create",
+ "path": "v2beta1/{+parent}/entityTypes",
+ "request": {
+ "$ref": "SessionEntityType"
+ },
+ "description": "Creates a session entity type.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "SessionEntityType"
+ },
+ "parameters": {
+ "parent": {
+ "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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes"
+ },
+ "delete": {
+ "description": "Deletes the specified session entity type.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.agent.sessions.entityTypes.delete"
+ },
+ "list": {
+ "id": "dialogflow.projects.agent.sessions.entityTypes.list",
+ "path": "v2beta1/{+parent}/entityTypes",
+ "description": "Returns the list of all session entity types in the specified session.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListSessionEntityTypesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "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/[^/]+$"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes"
+ },
+ "get": {
+ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}",
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.agent.sessions.entityTypes.get",
+ "description": "Retrieves the specified session entity type.",
+ "response": {
+ "$ref": "SessionEntityType"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the session entity type. 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"
+ ]
+ },
+ "patch": {
+ "response": {
+ "$ref": "SessionEntityType"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "Optional. The mask to control which fields get updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "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`.",
+ "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}",
+ "path": "v2beta1/{+name}",
+ "id": "dialogflow.projects.agent.sessions.entityTypes.patch",
+ "request": {
+ "$ref": "SessionEntityType"
+ },
+ "description": "Updates the specified session entity type."
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "get": {
+ "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"
+ },
+ "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/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/operations/{operationsId}"
+ }
+ }
+ }
+ }
+ }
}
}
diff --git a/digitalassetlinks/v1/digitalassetlinks-api.json b/digitalassetlinks/v1/digitalassetlinks-api.json
index 527b663..ea3d45e 100644
--- a/digitalassetlinks/v1/digitalassetlinks-api.json
+++ b/digitalassetlinks/v1/digitalassetlinks-api.json
@@ -1,9 +1,8 @@
{
- "version": "v1",
"baseUrl": "https://digitalassetlinks.googleapis.com/",
- "servicePath": "",
- "description": "API for discovering relationships between online assets such as web sites or mobile apps.",
"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",
@@ -13,23 +12,27 @@
"documentationLink": "https://developers.google.com/digital-asset-links/",
"id": "digitalassetlinks:v1",
"title": "Digital Asset Links API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"version_module": true,
"resources": {
"statements": {
"methods": {
"list": {
- "httpMethod": "GET",
+ "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.",
"response": {
"$ref": "ListResponse"
},
"parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
"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": {
"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",
@@ -37,51 +40,37 @@
"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": {
"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"
}
- },
- "flatPath": "v1/statements:list",
- "id": "digitalassetlinks.statements.list",
- "path": "v1/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."
+ }
}
}
},
"assetlinks": {
"methods": {
"check": {
+ "httpMethod": "GET",
+ "parameterOrder": [],
"response": {
"$ref": "CheckResponse"
},
- "parameterOrder": [],
- "httpMethod": "GET",
"parameters": {
- "target.web.site": {
+ "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",
"type": "string",
"location": "query"
},
- "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"
- },
- "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"
- },
"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"
+ "type": "string",
+ "location": "query"
},
"target.androidApp.packageName": {
"location": "query",
@@ -89,19 +78,29 @@
"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"
+ "type": "string",
+ "location": "query"
},
"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"
+ },
+ "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"
+ },
+ "target.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"
}
},
"flatPath": "v1/assetlinks:check",
- "path": "v1/assetlinks:check",
"id": "digitalassetlinks.assetlinks.check",
+ "path": "v1/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)."
}
}
@@ -109,9 +108,9 @@
},
"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"
+ "type": "string",
+ "location": "query"
},
"pp": {
"description": "Pretty-print response.",
@@ -119,14 +118,14 @@
"default": "true",
"location": "query"
},
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
- "bearer_token": {
+ "oauth_token": {
"location": "query",
- "description": "OAuth bearer token.",
+ "description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"upload_protocol": {
@@ -141,16 +140,23 @@
"location": "query"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "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": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -159,17 +165,9 @@
"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",
@@ -182,40 +180,40 @@
"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"
- },
- "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"
}
},
"schemas": {
- "ListResponse": {
- "description": "Response message for the List call.",
+ "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": {
- "statements": {
- "description": "A list of all the matching statements that have been found.",
- "type": "array",
- "items": {
- "$ref": "Statement"
- }
+ "web": {
+ "$ref": "WebAsset",
+ "description": "Set if this is a web asset."
},
- "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",
- "type": "string"
- },
+ "androidApp": {
+ "description": "Set if this is an Android App asset.",
+ "$ref": "AndroidAppAsset"
+ }
+ },
+ "id": "Asset"
+ },
+ "CheckResponse": {
+ "description": "Response message for the CheckAssetLinks call.",
+ "type": "object",
+ "properties": {
"errorCode": {
"enumDescriptions": [
"",
@@ -230,7 +228,7 @@
"A secure asset includes an insecure asset (security downgrade).",
"Too many includes (maybe a loop)."
],
- "description": "Error codes that describe the result of the List operation.",
+ "description": "Error codes that describe the result of the Check operation.",
"type": "array",
"items": {
"enum": [
@@ -248,6 +246,86 @@
],
"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"
+ },
+ "maxAge": {
+ "description": "From serving time, how much longer the response should be considered valid\nbarring further updates.\nREQUIRED",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "id": "CheckResponse"
+ },
+ "WebAsset": {
+ "description": "Describes a web asset.",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ },
+ "id": "WebAsset"
+ },
+ "ListResponse": {
+ "description": "Response message for the List call.",
+ "type": "object",
+ "properties": {
+ "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",
+ "type": "string"
+ },
+ "errorCode": {
+ "description": "Error codes that describe the result of the List operation.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "ERROR_CODE_UNSPECIFIED",
+ "ERROR_CODE_INVALID_QUERY",
+ "ERROR_CODE_FETCH_ERROR",
+ "ERROR_CODE_FAILED_SSL_VALIDATION",
+ "ERROR_CODE_REDIRECT",
+ "ERROR_CODE_TOO_LARGE",
+ "ERROR_CODE_MALFORMED_HTTP_RESPONSE",
+ "ERROR_CODE_WRONG_CONTENT_TYPE",
+ "ERROR_CODE_MALFORMED_CONTENT",
+ "ERROR_CODE_SECURE_ASSET_INCLUDES_INSECURE",
+ "ERROR_CODE_FETCH_BUDGET_EXHAUSTED"
+ ],
+ "type": "string"
+ },
+ "enumDescriptions": [
+ "",
+ "Unable to parse query.",
+ "Unable to fetch the asset links data.",
+ "Invalid HTTPS certificate .",
+ "HTTP redirects (e.g, 301) are not allowed.",
+ "Asset links data exceeds maximum size.",
+ "Can't parse HTTP response.",
+ "HTTP Content-type should be application/json.",
+ "JSON content is malformed.",
+ "A secure asset includes an insecure asset (security downgrade).",
+ "Too many includes (maybe a loop)."
+ ]
+ },
+ "statements": {
+ "description": "A list of all the matching statements that have been found.",
+ "type": "array",
+ "items": {
+ "$ref": "Statement"
+ }
}
},
"id": "ListResponse"
@@ -261,8 +339,8 @@
"$ref": "Asset"
},
"source": {
- "description": "Every statement has a source asset.\nREQUIRED",
- "$ref": "Asset"
+ "$ref": "Asset",
+ "description": "Every statement has a source asset.\nREQUIRED"
},
"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",
@@ -296,90 +374,12 @@
}
},
"id": "CertificateInfo"
- },
- "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.",
- "$ref": "WebAsset"
- },
- "androidApp": {
- "description": "Set if this is an Android App asset.",
- "$ref": "AndroidAppAsset"
- }
- },
- "id": "Asset"
- },
- "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",
- "type": "string"
- },
- "errorCode": {
- "enumDescriptions": [
- "",
- "Unable to parse query.",
- "Unable to fetch the asset links data.",
- "Invalid HTTPS certificate .",
- "HTTP redirects (e.g, 301) are not allowed.",
- "Asset links data exceeds maximum size.",
- "Can't parse HTTP response.",
- "HTTP Content-type should be application/json.",
- "JSON content is malformed.",
- "A secure asset includes an insecure asset (security downgrade).",
- "Too many includes (maybe a loop)."
- ],
- "description": "Error codes that describe the result of the Check operation.",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "ERROR_CODE_INVALID_QUERY",
- "ERROR_CODE_FETCH_ERROR",
- "ERROR_CODE_FAILED_SSL_VALIDATION",
- "ERROR_CODE_REDIRECT",
- "ERROR_CODE_TOO_LARGE",
- "ERROR_CODE_MALFORMED_HTTP_RESPONSE",
- "ERROR_CODE_WRONG_CONTENT_TYPE",
- "ERROR_CODE_MALFORMED_CONTENT",
- "ERROR_CODE_SECURE_ASSET_INCLUDES_INSECURE",
- "ERROR_CODE_FETCH_BUDGET_EXHAUSTED"
- ]
- }
- }
- },
- "id": "CheckResponse"
- },
- "WebAsset": {
- "description": "Describes a web asset.",
- "type": "object",
- "properties": {
- "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"
- }
- },
- "id": "WebAsset"
}
},
"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"
}
diff --git a/dlp/v2beta1/dlp-api.json b/dlp/v2beta1/dlp-api.json
index 2cb6a18..216b8b5 100644
--- a/dlp/v2beta1/dlp-api.json
+++ b/dlp/v2beta1/dlp-api.json
@@ -1,24 +1,206 @@
{
- "id": "dlp:v2beta1",
"documentationLink": "https://cloud.google.com/dlp/docs/",
+ "id": "dlp:v2beta1",
"revision": "20171212",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "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"
+ },
+ "GooglePrivacyDlpV2beta1InfoTypeTransformation": {
+ "description": "A transformation to apply to text that is identified as a specific\ninfo_type.",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ },
+ "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."
+ },
+ "privacyMetric": {
+ "description": "Privacy metric to compute.",
+ "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest"
+ },
+ "GooglePrivacyDlpV2beta1KAnonymityResult": {
+ "description": "Result of the k-anonymity computation.",
+ "type": "object",
+ "properties": {
+ "equivalenceClassHistogramBuckets": {
+ "description": "Histogram of k-anonymity equivalence classes.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1KAnonymityResult"
+ },
+ "GooglePrivacyDlpV2beta1Bucket": {
+ "description": "Buckets represented as ranges, along with replacement values. Ranges must\nbe non-overlapping.",
+ "type": "object",
+ "properties": {
+ "min": {
+ "$ref": "GooglePrivacyDlpV2beta1Value",
+ "description": "Lower bound of the range, inclusive. Type should be the same as max if\nused."
+ },
+ "max": {
+ "$ref": "GooglePrivacyDlpV2beta1Value",
+ "description": "Upper bound of the range, exclusive; type must match min."
+ },
+ "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"
+ },
+ "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": {
+ "description": "Lower bound on the value frequency of the values in this bucket.",
+ "format": "int64",
+ "type": "string"
+ },
+ "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"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket"
+ },
+ "GooglePrivacyDlpV2beta1TableLocation": {
+ "description": "Location of a finding within a `ContentItem.Table`.",
+ "type": "object",
+ "properties": {
+ "rowIndex": {
+ "description": "The zero-based index of the row where the finding is located.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1TableLocation"
+ },
+ "GooglePrivacyDlpV2beta1DatastoreKey": {
+ "description": "Record key for a finding in Cloud Datastore.",
+ "type": "object",
+ "properties": {
+ "entityKey": {
+ "description": "Datastore entity key.",
+ "$ref": "GooglePrivacyDlpV2beta1Key"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1DatastoreKey"
+ },
+ "GooglePrivacyDlpV2beta1KAnonymityConfig": {
+ "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"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1KAnonymityConfig"
+ },
+ "GooglePrivacyDlpV2beta1RecordKey": {
+ "description": "Message for a unique key indicating a record that contains a finding.",
+ "type": "object",
+ "properties": {
+ "datastoreKey": {
+ "$ref": "GooglePrivacyDlpV2beta1DatastoreKey"
+ },
+ "cloudStorageKey": {
+ "$ref": "GooglePrivacyDlpV2beta1CloudStorageKey"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1RecordKey"
+ },
+ "GooglePrivacyDlpV2beta1DeidentifyContentRequest": {
+ "description": "Request to de-identify a list of items.",
+ "type": "object",
+ "properties": {
+ "items": {
+ "description": "The list of items to inspect. Up to 100 are allowed per request.\nAll items will be treated as text/*.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1ContentItem"
+ }
+ },
+ "deidentifyConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1DeidentifyConfig",
+ "description": "Configuration for the de-identification of the list of content items."
+ },
+ "inspectConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
+ "description": "Configuration for the inspector."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1DeidentifyContentRequest"
+ },
"GooglePrivacyDlpV2beta1InspectResult": {
"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": "GooglePrivacyDlpV2beta1Finding"
}
- },
- "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"
}
},
"id": "GooglePrivacyDlpV2beta1InspectResult"
@@ -37,6 +219,8 @@
"id": "GooglePrivacyDlpV2beta1QuasiIdField"
},
"GooglePrivacyDlpV2beta1ImageLocation": {
+ "description": "Bounding box encompassing detected text within an image.",
+ "type": "object",
"properties": {
"height": {
"description": "Height of the bounding box in pixels.",
@@ -59,9 +243,7 @@
"type": "integer"
}
},
- "id": "GooglePrivacyDlpV2beta1ImageLocation",
- "description": "Bounding box encompassing detected text within an image.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1ImageLocation"
},
"GooglePrivacyDlpV2beta1ReplaceValueConfig": {
"description": "Replace each input value with a given `Value`.",
@@ -78,6 +260,10 @@
"description": "Container structure for the content to inspect.",
"type": "object",
"properties": {
+ "table": {
+ "description": "Structured content for inspection.",
+ "$ref": "GooglePrivacyDlpV2beta1Table"
+ },
"data": {
"description": "Content data to inspect or redact.",
"format": "byte",
@@ -90,32 +276,14 @@
"value": {
"description": "String data to inspect or redact.",
"type": "string"
- },
- "table": {
- "description": "Structured content for inspection.",
- "$ref": "GooglePrivacyDlpV2beta1Table"
}
},
"id": "GooglePrivacyDlpV2beta1ContentItem"
},
"GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig": {
+ "description": "Replaces an identifier with a surrogate using FPE with the FFX\nmode of operation.\nThe identifier must be representable by the US-ASCII character set.\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": {
- "$ref": "GooglePrivacyDlpV2beta1CryptoKey",
- "description": "The key used by the encryption algorithm. [required]"
- },
- "context": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId",
- "description": "A context may be used for higher security since the same\nidentifier in two different contexts likely will be given a distinct\nsurrogate. The principle is that the likeliness is inversely related\nto the ratio of the number of distinct identifiers per context over the\nnumber of possible surrogates: As long as this ratio is small, the\nlikehood is large.\n\nIf the context is not set, a default tweak will be used.\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 2\n\nThis is also known as the 'tweak', as in tweakable encryption."
- },
- "surrogateInfoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "The custom info type to annotate the surrogate with.\nThis annotation will be applied to the surrogate by prefixing it with\nthe name of the custom info type 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 info type 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 info type\n[`SurrogateType`](/dlp/docs/reference/rest/v2beta1/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 info type 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 info type 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": [
"",
@@ -137,13 +305,29 @@
"description": "The native way to select the alphabet. Must be in the range [2, 62].",
"format": "int32",
"type": "integer"
+ },
+ "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": {
+ "$ref": "GooglePrivacyDlpV2beta1CryptoKey",
+ "description": "The key used by the encryption algorithm. [required]"
+ },
+ "context": {
+ "description": "A context may be used for higher security since the same\nidentifier in two different contexts likely will be given a distinct\nsurrogate. The principle is that the likeliness is inversely related\nto the ratio of the number of distinct identifiers per context over the\nnumber of possible surrogates: As long as this ratio is small, the\nlikehood is large.\n\nIf the context is not set, a default tweak will be used.\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 2\n\nThis is also known as the 'tweak', as in tweakable encryption.",
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ },
+ "surrogateInfoType": {
+ "description": "The custom info type to annotate the surrogate with.\nThis annotation will be applied to the surrogate by prefixing it with\nthe name of the custom info type 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 info type 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 info type\n[`SurrogateType`](/dlp/docs/reference/rest/v2beta1/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 info type 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 info type 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",
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
}
},
- "id": "GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig",
- "description": "Replaces an identifier with a surrogate using FPE with the FFX\nmode of operation.\nThe identifier must be representable by the US-ASCII character set.\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"
+ "id": "GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig"
},
"GooglePrivacyDlpV2beta1Color": {
+ "description": "Represents a color in the RGB color space.",
+ "type": "object",
"properties": {
"green": {
"description": "The amount of green in the color as a value in the interval [0, 1].",
@@ -161,63 +345,61 @@
"type": "number"
}
},
- "id": "GooglePrivacyDlpV2beta1Color",
- "description": "Represents a color in the RGB color space.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta1ValueFrequency": {
- "description": "A value of a field, including its frequency.",
- "type": "object",
- "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"
- },
- "GooglePrivacyDlpV2beta1SurrogateType": {
- "type": "object",
- "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`."
+ "id": "GooglePrivacyDlpV2beta1Color"
},
"GooglePrivacyDlpV2beta1Table": {
"description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed.",
"type": "object",
"properties": {
- "headers": {
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
- }
- },
"rows": {
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1Row"
}
+ },
+ "headers": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ }
}
},
"id": "GooglePrivacyDlpV2beta1Table"
},
+ "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`.",
+ "type": "object",
+ "properties": {},
+ "id": "GooglePrivacyDlpV2beta1SurrogateType"
+ },
+ "GooglePrivacyDlpV2beta1ValueFrequency": {
+ "description": "A value of a field, including its frequency.",
+ "type": "object",
+ "properties": {
+ "count": {
+ "description": "How many times the value is contained in the field.",
+ "format": "int64",
+ "type": "string"
+ },
+ "value": {
+ "$ref": "GooglePrivacyDlpV2beta1Value",
+ "description": "A value contained in the field in question."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1ValueFrequency"
+ },
"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.",
"type": "object",
"properties": {
- "unwrapped": {
- "$ref": "GooglePrivacyDlpV2beta1UnwrappedCryptoKey"
- },
"transient": {
"$ref": "GooglePrivacyDlpV2beta1TransientCryptoKey"
},
"kmsWrapped": {
"$ref": "GooglePrivacyDlpV2beta1KmsWrappedCryptoKey"
+ },
+ "unwrapped": {
+ "$ref": "GooglePrivacyDlpV2beta1UnwrappedCryptoKey"
}
},
"id": "GooglePrivacyDlpV2beta1CryptoKey"
@@ -226,33 +408,22 @@
"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"
- },
- "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"
},
"GooglePrivacyDlpV2beta1LDiversityHistogramBucket": {
- "id": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket",
"description": "Histogram bucket of sensitive value frequencies in the table.",
"type": "object",
"properties": {
- "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"
- },
"sensitiveValueFrequencyLowerBound": {
"description": "Lower bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.",
"format": "int64",
@@ -264,20 +435,24 @@
"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.",
"type": "object",
"properties": {
- "timeValue": {
- "$ref": "GoogleTypeTimeOfDay"
- },
- "integerValue": {
- "type": "string",
- "format": "int64"
- },
"stringValue": {
"type": "string"
},
@@ -294,6 +469,13 @@
"floatValue": {
"format": "double",
"type": "number"
+ },
+ "integerValue": {
+ "format": "int64",
+ "type": "string"
+ },
+ "timeValue": {
+ "$ref": "GoogleTypeTimeOfDay"
}
},
"id": "GooglePrivacyDlpV2beta1Value"
@@ -302,6 +484,10 @@
"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]"
+ },
"operator": {
"enumDescriptions": [
"",
@@ -327,12 +513,8 @@
"type": "string"
},
"value": {
- "description": "Value to compare against. [Required, except for `EXISTS` tests.]",
- "$ref": "GooglePrivacyDlpV2beta1Value"
- },
- "field": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId",
- "description": "Field within the record this condition is evaluated against. [required]"
+ "$ref": "GooglePrivacyDlpV2beta1Value",
+ "description": "Value to compare against. [Required, except for `EXISTS` tests.]"
}
},
"id": "GooglePrivacyDlpV2beta1Condition"
@@ -341,13 +523,13 @@
"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"
- },
"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"
@@ -378,11 +560,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.",
@@ -413,7 +595,6 @@
"id": "GooglePrivacyDlpV2beta1WordList"
},
"GooglePrivacyDlpV2beta1FieldId": {
- "id": "GooglePrivacyDlpV2beta1FieldId",
"description": "General identifier of a data field in a storage service.",
"type": "object",
"properties": {
@@ -421,12 +602,21 @@
"description": "Name describing the field.",
"type": "string"
}
- }
+ },
+ "id": "GooglePrivacyDlpV2beta1FieldId"
},
"GooglePrivacyDlpV2beta1TransformationSummary": {
"description": "Summary of a single tranformation.",
"type": "object",
"properties": {
+ "infoType": {
+ "description": "Set if the transformation was limited to a specific info_type.",
+ "$ref": "GooglePrivacyDlpV2beta1InfoType"
+ },
+ "transformation": {
+ "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation",
+ "description": "The specific transformation these stats apply to."
+ },
"results": {
"type": "array",
"items": {
@@ -434,8 +624,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. This list will contain\nmultiple only in the case of errors.",
@@ -445,16 +635,8 @@
}
},
"recordSuppress": {
- "$ref": "GooglePrivacyDlpV2beta1RecordSuppression",
- "description": "The specific suppression option these stats apply to."
- },
- "infoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "Set if the transformation was limited to a specific info_type."
- },
- "transformation": {
- "description": "The specific transformation these stats apply to.",
- "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation"
+ "description": "The specific suppression option these stats apply to.",
+ "$ref": "GooglePrivacyDlpV2beta1RecordSuppression"
}
},
"id": "GooglePrivacyDlpV2beta1TransformationSummary"
@@ -466,7 +648,6 @@
"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": {
@@ -475,8 +656,8 @@
"type": "string"
},
"reverseOrder": {
- "type": "boolean",
- "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***"
+ "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.",
@@ -490,7 +671,8 @@
"$ref": "GooglePrivacyDlpV2beta1CharsToIgnore"
}
}
- }
+ },
+ "id": "GooglePrivacyDlpV2beta1CharacterMaskConfig"
},
"GooglePrivacyDlpV2beta1TransientCryptoKey": {
"description": "Use this to have a random data crypto key generated.\nIt will be discarded after the operation/request finishes.",
@@ -504,39 +686,35 @@
"id": "GooglePrivacyDlpV2beta1TransientCryptoKey"
},
"GooglePrivacyDlpV2beta1CreateInspectOperationRequest": {
+ "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.",
+ "type": "object",
"properties": {
+ "operationConfig": {
+ "description": "Additional configuration settings for long running operations.",
+ "$ref": "GooglePrivacyDlpV2beta1OperationConfig"
+ },
"inspectConfig": {
"description": "Configuration for the inspector.",
"$ref": "GooglePrivacyDlpV2beta1InspectConfig"
},
"storageConfig": {
- "$ref": "GooglePrivacyDlpV2beta1StorageConfig",
- "description": "Specification of the data set to process."
+ "description": "Specification of the data set to process.",
+ "$ref": "GooglePrivacyDlpV2beta1StorageConfig"
},
"outputConfig": {
- "description": "Optional location to store findings.",
- "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig"
- },
- "operationConfig": {
- "description": "Additional configuration settings for long running operations.",
- "$ref": "GooglePrivacyDlpV2beta1OperationConfig"
+ "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig",
+ "description": "Optional location to store findings."
}
},
- "id": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest",
- "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.",
- "type": "object"
+ "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": {
- "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.",
- "$ref": "GooglePrivacyDlpV2beta1InfoType"
+ "$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",
@@ -545,6 +723,10 @@
"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"
@@ -567,14 +749,14 @@
"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"
- },
- "infoType": {
- "description": "The type of finding this stat is for.",
- "$ref": "GooglePrivacyDlpV2beta1InfoType"
}
},
"id": "GooglePrivacyDlpV2beta1InfoTypeStatistics"
@@ -591,32 +773,27 @@
"id": "GooglePrivacyDlpV2beta1PropertyReference"
},
"GooglePrivacyDlpV2beta1OutputStorageConfig": {
+ "description": "Cloud repository for storing output.",
"type": "object",
"properties": {
- "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"
- },
"table": {
- "description": "Store findings in a new table in the dataset.",
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
+ "description": "Store findings in a new table in the dataset."
+ },
+ "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"
}
},
- "id": "GooglePrivacyDlpV2beta1OutputStorageConfig",
- "description": "Cloud repository for storing output."
+ "id": "GooglePrivacyDlpV2beta1OutputStorageConfig"
},
"GooglePrivacyDlpV2beta1FieldTransformation": {
- "id": "GooglePrivacyDlpV2beta1FieldTransformation",
"description": "The transformation to apply to the field.",
"type": "object",
"properties": {
- "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."
- },
"infoTypeTransformations": {
- "$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformations",
- "description": "Treat the contents of the field as free text, and selectively\ntransform content that matches an `InfoType`."
+ "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]",
@@ -626,10 +803,15 @@
}
},
"primitiveTransformation": {
- "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation",
- "description": "Apply the transformation to the entire field."
+ "description": "Apply the transformation to the entire field.",
+ "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation"
+ },
+ "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.",
@@ -648,23 +830,25 @@
"description": "Results of de-identifying a list of items.",
"type": "object",
"properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1ContentItem"
+ }
+ },
"summaries": {
"description": "A review of the transformations that took place for each item.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1DeidentificationSummary"
}
- },
- "items": {
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ContentItem"
- }
}
},
"id": "GooglePrivacyDlpV2beta1DeidentifyContentResponse"
},
"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.",
@@ -672,30 +856,30 @@
"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"
- },
- "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."
+ }
}
},
- "id": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass",
- "description": "The set of columns' values that share the same k-anonymity value.",
- "type": "object"
+ "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"
},
"response": {
+ "description": "This field will contain an InspectOperationResult object for `inspect.operations.create` or a RiskAnalysisOperationResult object for `dataSource.analyze`.",
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "description": "This field will contain an InspectOperationResult object for `inspect.operations.create` or a RiskAnalysisOperationResult object for `dataSource.analyze`.",
- "type": "object"
+ }
},
"name": {
"description": "The server-assigned name. The `name` should have the format of `inspect/operations/\u003cidentifier\u003e`.",
@@ -706,39 +890,38 @@
"description": "The error result of the operation in case of failure or cancellation."
},
"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"
- },
- "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"
+ }
}
},
- "id": "GoogleLongrunningOperation",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object"
+ "id": "GoogleLongrunningOperation"
},
"GooglePrivacyDlpV2beta1InspectOperationMetadata": {
"description": "Metadata returned within GetOperation for an inspect request.",
"type": "object",
"properties": {
- "requestOutputConfig": {
- "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig",
- "description": "Optional location to store findings."
- },
"createTime": {
"description": "The time which this request was started.",
"format": "google-datetime",
"type": "string"
},
+ "processedBytes": {
+ "description": "Total size in bytes that were processed.",
+ "format": "int64",
+ "type": "string"
+ },
"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"
+ "totalEstimatedBytes": {
+ "description": "Estimate of the number of bytes to process.",
+ "format": "int64",
+ "type": "string"
},
"infoTypeStats": {
"type": "array",
@@ -746,14 +929,13 @@
"$ref": "GooglePrivacyDlpV2beta1InfoTypeStatistics"
}
},
- "totalEstimatedBytes": {
- "description": "Estimate of the number of bytes to process.",
- "format": "int64",
- "type": "string"
- },
"requestInspectConfig": {
- "description": "The inspect config used to create the Operation.",
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig",
+ "description": "The inspect config used to create the Operation."
+ },
+ "requestOutputConfig": {
+ "description": "Optional location to store findings.",
+ "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig"
}
},
"id": "GooglePrivacyDlpV2beta1InspectOperationMetadata"
@@ -789,7 +971,11 @@
"description": "Characters to skip when doing deidentification of a value. These will be left\nalone and skipped.",
"type": "object",
"properties": {
+ "charactersToSkip": {
+ "type": "string"
+ },
"commonCharactersToIgnore": {
+ "type": "string",
"enumDescriptions": [
"",
"0-9",
@@ -805,23 +991,18 @@
"ALPHA_LOWER_CASE",
"PUNCTUATION",
"WHITESPACE"
- ],
- "type": "string"
- },
- "charactersToSkip": {
- "type": "string"
+ ]
}
},
"id": "GooglePrivacyDlpV2beta1CharsToIgnore"
},
"GooglePrivacyDlpV2beta1FixedSizeBucketingConfig": {
- "id": "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig",
"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": {
- "$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]."
+ "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].",
@@ -832,19 +1013,13 @@
"$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]."
}
- }
+ },
+ "id": "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig"
},
"GooglePrivacyDlpV2beta1RiskAnalysisOperationResult": {
- "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationResult",
"description": "Result of a risk analysis\n[`Operation`](/dlp/docs/reference/rest/v2beta1/inspect.operations)\nrequest.",
"type": "object",
"properties": {
- "lDiversityResult": {
- "$ref": "GooglePrivacyDlpV2beta1LDiversityResult"
- },
- "categoricalStatsResult": {
- "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsResult"
- },
"numericalStatsResult": {
"$ref": "GooglePrivacyDlpV2beta1NumericalStatsResult"
},
@@ -853,8 +1028,15 @@
},
"kAnonymityResult": {
"$ref": "GooglePrivacyDlpV2beta1KAnonymityResult"
+ },
+ "lDiversityResult": {
+ "$ref": "GooglePrivacyDlpV2beta1LDiversityResult"
+ },
+ "categoricalStatsResult": {
+ "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsResult"
}
- }
+ },
+ "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationResult"
},
"GooglePrivacyDlpV2beta1CategoryDescription": {
"description": "Info Type Category description.",
@@ -872,6 +1054,7 @@
"id": "GooglePrivacyDlpV2beta1CategoryDescription"
},
"GooglePrivacyDlpV2beta1Conditions": {
+ "type": "object",
"properties": {
"conditions": {
"type": "array",
@@ -880,22 +1063,30 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta1Conditions",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1Conditions"
},
"GooglePrivacyDlpV2beta1PrimitiveTransformation": {
"description": "A rule for transforming a value.",
"type": "object",
"properties": {
+ "replaceConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1ReplaceValueConfig"
+ },
+ "timePartConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1TimePartConfig"
+ },
+ "fixedSizeBucketingConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig"
+ },
"characterMaskConfig": {
"$ref": "GooglePrivacyDlpV2beta1CharacterMaskConfig"
},
- "bucketingConfig": {
- "$ref": "GooglePrivacyDlpV2beta1BucketingConfig"
- },
"redactConfig": {
"$ref": "GooglePrivacyDlpV2beta1RedactConfig"
},
+ "bucketingConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1BucketingConfig"
+ },
"replaceWithInfoTypeConfig": {
"$ref": "GooglePrivacyDlpV2beta1ReplaceWithInfoTypeConfig"
},
@@ -904,20 +1095,12 @@
},
"cryptoReplaceFfxFpeConfig": {
"$ref": "GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig"
- },
- "replaceConfig": {
- "$ref": "GooglePrivacyDlpV2beta1ReplaceValueConfig"
- },
- "fixedSizeBucketingConfig": {
- "$ref": "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig"
- },
- "timePartConfig": {
- "$ref": "GooglePrivacyDlpV2beta1TimePartConfig"
}
},
"id": "GooglePrivacyDlpV2beta1PrimitiveTransformation"
},
"GooglePrivacyDlpV2beta1CategoricalStatsConfig": {
+ "description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.",
"type": "object",
"properties": {
"field": {
@@ -925,14 +1108,46 @@
"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",
- "description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution."
+ "id": "GooglePrivacyDlpV2beta1CategoricalStatsConfig"
+ },
+ "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"
+ }
+ },
+ "quasiIds": {
+ "description": "Fields considered to be quasi-identifiers. No two columns can have the\nsame tag. [required]",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1TaggedField"
+ }
+ },
+ "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": "GooglePrivacyDlpV2beta1KMapEstimationConfig"
},
"GooglePrivacyDlpV2beta1Finding": {
- "id": "GooglePrivacyDlpV2beta1Finding",
"description": "Container structure describing a single finding within a string or image.",
"type": "object",
"properties": {
+ "infoType": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoType",
+ "description": "The specific type of info the string might be."
+ },
+ "createTime": {
+ "description": "Timestamp when finding was detected.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"quote": {
"description": "The specific string that may be potentially sensitive info.",
"type": "string"
@@ -960,42 +1175,9 @@
"LIKELY",
"VERY_LIKELY"
]
- },
- "infoType": {
- "$ref": "GooglePrivacyDlpV2beta1InfoType",
- "description": "The specific type of info the string might be."
- },
- "createTime": {
- "description": "Timestamp when finding was detected.",
- "format": "google-datetime",
- "type": "string"
- }
- }
- },
- "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"
- }
- },
- "quasiIds": {
- "description": "Fields considered to be quasi-identifiers. No two columns can have the\nsame tag. [required]",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1TaggedField"
- }
- },
- "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": "GooglePrivacyDlpV2beta1KMapEstimationConfig"
+ "id": "GooglePrivacyDlpV2beta1Finding"
},
"GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata": {
"description": "Metadata returned within the\n[`riskAnalysis.operations.get`](/dlp/docs/reference/rest/v2beta1/riskAnalysis.operations/get)\nfor risk analysis.",
@@ -1021,16 +1203,16 @@
"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"
@@ -1047,12 +1229,6 @@
},
"id": "GooglePrivacyDlpV2beta1Row"
},
- "GoogleProtobufEmpty": {
- "properties": {},
- "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"
- },
"GooglePrivacyDlpV2beta1ListInspectFindingsResponse": {
"description": "Response to the ListInspectFindings request.",
"type": "object",
@@ -1062,15 +1238,51 @@
"type": "string"
},
"result": {
- "$ref": "GooglePrivacyDlpV2beta1InspectResult",
- "description": "The results."
+ "description": "The results.",
+ "$ref": "GooglePrivacyDlpV2beta1InspectResult"
}
},
"id": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse"
},
- "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket": {
+ "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"
+ },
+ "GooglePrivacyDlpV2beta1Expressions": {
+ "description": "A collection of expressions",
"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": "GooglePrivacyDlpV2beta1Conditions"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1Expressions"
+ },
+ "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",
@@ -1085,39 +1297,9 @@
"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."
- },
- "GooglePrivacyDlpV2beta1Expressions": {
- "description": "A collection of expressions",
- "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": [
- "",
- ""
- ],
- "enum": [
- "LOGICAL_OPERATOR_UNSPECIFIED",
- "AND"
- ]
- },
- "conditions": {
- "$ref": "GooglePrivacyDlpV2beta1Conditions"
- }
- },
- "id": "GooglePrivacyDlpV2beta1Expressions"
+ "id": "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket"
},
"GooglePrivacyDlpV2beta1CloudStorageOptions": {
"description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket.",
@@ -1130,7 +1312,6 @@
"id": "GooglePrivacyDlpV2beta1CloudStorageOptions"
},
"GooglePrivacyDlpV2beta1CloudStoragePath": {
- "id": "GooglePrivacyDlpV2beta1CloudStoragePath",
"description": "A location in Cloud Storage.",
"type": "object",
"properties": {
@@ -1138,19 +1319,24 @@
"description": "The url, in the format of `gs://bucket/\u003cpath\u003e`.",
"type": "string"
}
- }
+ },
+ "id": "GooglePrivacyDlpV2beta1CloudStoragePath"
+ },
+ "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"
},
"GooglePrivacyDlpV2beta1KAnonymityHistogramBucket": {
"description": "Histogram bucket of equivalence class sizes in the table.",
"type": "object",
"properties": {
- "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"
- }
- },
"equivalenceClassSizeLowerBound": {
"description": "Lower bound on the size of the equivalence classes in this bucket.",
"format": "int64",
@@ -1165,20 +1351,47 @@
"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"
},
- "GooglePrivacyDlpV2beta1InspectOperationResult": {
- "description": "The operational data.",
+ "GooglePrivacyDlpV2beta1Range": {
+ "description": "Generic half-open interval [start, end)",
"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}`.",
+ "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": "GooglePrivacyDlpV2beta1InspectOperationResult"
+ "id": "GooglePrivacyDlpV2beta1Range"
+ },
+ "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"
},
"GooglePrivacyDlpV2beta1LDiversityResult": {
"description": "Result of the l-diversity computation.",
@@ -1194,41 +1407,15 @@
},
"id": "GooglePrivacyDlpV2beta1LDiversityResult"
},
- "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"
- },
- "GooglePrivacyDlpV2beta1Range": {
- "description": "Generic half-open interval [start, end)",
- "type": "object",
- "properties": {
- "start": {
- "description": "Index of the first character of the range (inclusive).",
- "format": "int64",
- "type": "string"
- },
- "end": {
- "description": "Index of the last character of the range (exclusive).",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1Range"
- },
"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",
@@ -1243,11 +1430,6 @@
"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"
@@ -1268,31 +1450,30 @@
"id": "GooglePrivacyDlpV2beta1DeidentifyConfig"
},
"GooglePrivacyDlpV2beta1LDiversityConfig": {
- "id": "GooglePrivacyDlpV2beta1LDiversityConfig",
"description": "l-diversity metric, used for analysis of reidentification risk.",
"type": "object",
"properties": {
"sensitiveAttribute": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId",
- "description": "Sensitive field for computing the l-value."
+ "description": "Sensitive field for computing the l-value.",
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
},
"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"
},
"GooglePrivacyDlpV2beta1StorageConfig": {
- "id": "GooglePrivacyDlpV2beta1StorageConfig",
"description": "Shared message indicating Cloud storage type.",
"type": "object",
"properties": {
"cloudStorageOptions": {
- "description": "Google Cloud Storage options specification.",
- "$ref": "GooglePrivacyDlpV2beta1CloudStorageOptions"
+ "$ref": "GooglePrivacyDlpV2beta1CloudStorageOptions",
+ "description": "Google Cloud Storage options specification."
},
"datastoreOptions": {
"description": "Google Cloud Datastore options specification.",
@@ -1302,7 +1483,20 @@
"description": "BigQuery options specification.",
"$ref": "GooglePrivacyDlpV2beta1BigQueryOptions"
}
- }
+ },
+ "id": "GooglePrivacyDlpV2beta1StorageConfig"
+ },
+ "GooglePrivacyDlpV2beta1OperationConfig": {
+ "description": "Additional configuration for inspect long running operations.",
+ "type": "object",
+ "properties": {
+ "maxItemFindings": {
+ "description": "Max number of findings per file, Datastore entity, or database row.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1OperationConfig"
},
"GooglePrivacyDlpV2beta1BigQueryOptions": {
"description": "Options defining BigQuery table and row identifiers.",
@@ -1322,20 +1516,16 @@
},
"id": "GooglePrivacyDlpV2beta1BigQueryOptions"
},
- "GooglePrivacyDlpV2beta1OperationConfig": {
- "description": "Additional configuration for inspect long running operations.",
+ "GooglePrivacyDlpV2beta1PrivacyMetric": {
+ "description": "Privacy metric to compute for reidentification risk analysis.",
"type": "object",
"properties": {
- "maxItemFindings": {
- "description": "Max number of findings per file, Datastore entity, or database row.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1OperationConfig"
- },
- "GooglePrivacyDlpV2beta1PrivacyMetric": {
- "properties": {
+ "numericalStatsConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1NumericalStatsConfig"
+ },
+ "kAnonymityConfig": {
+ "$ref": "GooglePrivacyDlpV2beta1KAnonymityConfig"
+ },
"categoricalStatsConfig": {
"$ref": "GooglePrivacyDlpV2beta1CategoricalStatsConfig"
},
@@ -1344,17 +1534,9 @@
},
"lDiversityConfig": {
"$ref": "GooglePrivacyDlpV2beta1LDiversityConfig"
- },
- "numericalStatsConfig": {
- "$ref": "GooglePrivacyDlpV2beta1NumericalStatsConfig"
- },
- "kAnonymityConfig": {
- "$ref": "GooglePrivacyDlpV2beta1KAnonymityConfig"
}
},
- "id": "GooglePrivacyDlpV2beta1PrivacyMetric",
- "description": "Privacy metric to compute for reidentification risk analysis.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1PrivacyMetric"
},
"GooglePrivacyDlpV2beta1ReplaceConfig": {
"type": "object",
@@ -1371,16 +1553,20 @@
"id": "GooglePrivacyDlpV2beta1ReplaceConfig"
},
"GooglePrivacyDlpV2beta1LDiversityEquivalenceClass": {
- "id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass",
"description": "The set of columns' values that share the same l-diversity value.",
"type": "object",
"properties": {
+ "equivalenceClassSize": {
+ "description": "Size of the k-anonymity equivalence class.",
+ "format": "int64",
+ "type": "string"
+ },
"quasiIdsValues": {
+ "description": "Quasi-identifier values defining the k-anonymity equivalence\nclass. The order is always the same as the original request.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1Value"
- },
- "description": "Quasi-identifier values defining the k-anonymity equivalence\nclass. The order is always the same as the original request."
+ }
},
"numDistinctSensitiveValues": {
"description": "Number of distinct sensitive values in this equivalence class.",
@@ -1393,13 +1579,9 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta1ValueFrequency"
}
- },
- "equivalenceClassSize": {
- "description": "Size of the k-anonymity equivalence class.",
- "format": "int64",
- "type": "string"
}
- }
+ },
+ "id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass"
},
"GooglePrivacyDlpV2beta1NumericalStatsConfig": {
"description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.",
@@ -1441,30 +1623,30 @@
"id": "GooglePrivacyDlpV2beta1TimePartConfig"
},
"GooglePrivacyDlpV2beta1RecordCondition": {
+ "description": "A condition for determining whether a transformation should be applied to\na field.",
"type": "object",
"properties": {
"expressions": {
"$ref": "GooglePrivacyDlpV2beta1Expressions"
}
},
- "id": "GooglePrivacyDlpV2beta1RecordCondition",
- "description": "A condition for determining whether a transformation should be applied to\na field."
+ "id": "GooglePrivacyDlpV2beta1RecordCondition"
},
"GooglePrivacyDlpV2beta1DeidentificationSummary": {
"description": "High level summary of deidentification.",
"type": "object",
"properties": {
- "transformedBytes": {
- "description": "Total size in bytes that were transformed in some way.",
- "format": "int64",
- "type": "string"
- },
"transformationSummaries": {
"description": "Transformations applied to the dataset.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1TransformationSummary"
}
+ },
+ "transformedBytes": {
+ "description": "Total size in bytes that were transformed in some way.",
+ "format": "int64",
+ "type": "string"
}
},
"id": "GooglePrivacyDlpV2beta1DeidentificationSummary"
@@ -1504,8 +1686,8 @@
"type": "object",
"properties": {
"maxValue": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "Maximum value appearing in the column."
+ "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.",
@@ -1536,13 +1718,9 @@
"description": "Options defining a data set within Google Cloud Datastore.",
"type": "object",
"properties": {
- "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."
- },
"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.",
@@ -1550,6 +1728,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"
@@ -1566,11 +1748,11 @@
}
},
"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": "GooglePrivacyDlpV2beta1RecordSuppression"
- },
- "description": "Configuration defining which records get suppressed entirely. Records that\nmatch any suppression rule are omitted from the output [optional]."
+ }
}
},
"id": "GooglePrivacyDlpV2beta1RecordTransformations"
@@ -1579,6 +1761,17 @@
"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.",
@@ -1621,17 +1814,6 @@
"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"
- }
- },
- "excludeTypes": {
- "description": "When true, excludes type information of the findings.",
- "type": "boolean"
}
},
"id": "GooglePrivacyDlpV2beta1InspectConfig"
@@ -1653,18 +1835,8 @@
"properties": {},
"id": "GooglePrivacyDlpV2beta1RedactConfig"
},
- "GooglePrivacyDlpV2beta1CryptoHashConfig": {
- "description": "Pseudonymization method that generates surrogates via cryptographic hashing.\nUses SHA-256.\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",
- "properties": {
- "cryptoKey": {
- "$ref": "GooglePrivacyDlpV2beta1CryptoKey",
- "description": "The key used by the hash function."
- }
- },
- "id": "GooglePrivacyDlpV2beta1CryptoHashConfig"
- },
"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": {
@@ -1679,29 +1851,38 @@
}
}
},
- "id": "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."
+ "id": "GooglePrivacyDlpV2beta1Key"
+ },
+ "GooglePrivacyDlpV2beta1CryptoHashConfig": {
+ "description": "Pseudonymization method that generates surrogates via cryptographic hashing.\nUses SHA-256.\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",
+ "properties": {
+ "cryptoKey": {
+ "$ref": "GooglePrivacyDlpV2beta1CryptoKey",
+ "description": "The key used by the hash function."
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1CryptoHashConfig"
},
"GooglePrivacyDlpV2beta1InspectContentRequest": {
"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": {
- "description": "Configuration for the inspector.",
- "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
}
},
"id": "GooglePrivacyDlpV2beta1InspectContentRequest"
},
"GoogleTypeDate": {
- "id": "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`.",
"type": "object",
"properties": {
@@ -1720,7 +1901,27 @@
"format": "int32",
"type": "integer"
}
- }
+ },
+ "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.",
@@ -1728,55 +1929,36 @@
"properties": {},
"id": "GooglePrivacyDlpV2beta1ReplaceWithInfoTypeConfig"
},
- "GooglePrivacyDlpV2beta1ImageRedactionConfig": {
- "type": "object",
- "properties": {
- "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."
- },
- "redactionColor": {
- "description": "The color to use when redacting content from an image. If not specified,\nthe default is black.",
- "$ref": "GooglePrivacyDlpV2beta1Color"
- },
- "redactAllText": {
- "type": "boolean",
- "description": "If true, all text found in the image, regardless whether it matches an\ninfo_type, is redacted."
- }
- },
- "id": "GooglePrivacyDlpV2beta1ImageRedactionConfig",
- "description": "Configuration for determining how redaction of images should occur."
- },
"GooglePrivacyDlpV2beta1Location": {
"description": "Specifies the location of a finding within its source item.",
"type": "object",
"properties": {
+ "tableLocation": {
+ "description": "Location within a `ContentItem.Table`.",
+ "$ref": "GooglePrivacyDlpV2beta1TableLocation"
+ },
"codepointRange": {
"$ref": "GooglePrivacyDlpV2beta1Range",
"description": "Character offsets within a content item, included when content type\nis a text. Default charset assumed to be UTF-8."
},
"fieldId": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId",
- "description": "Field id of the field containing the finding."
+ "description": "Field id of the field containing the finding.",
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
},
"imageBoxes": {
+ "description": "Location within an image's pixels.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1ImageLocation"
- },
- "description": "Location within an image's pixels."
+ }
},
"byteRange": {
"description": "Zero-based byte offsets within a content item.",
"$ref": "GooglePrivacyDlpV2beta1Range"
},
"recordKey": {
- "$ref": "GooglePrivacyDlpV2beta1RecordKey",
- "description": "Key of the finding."
- },
- "tableLocation": {
- "description": "Location within a `ContentItem.Table`.",
- "$ref": "GooglePrivacyDlpV2beta1TableLocation"
+ "description": "Key of the finding.",
+ "$ref": "GooglePrivacyDlpV2beta1RecordKey"
}
},
"id": "GooglePrivacyDlpV2beta1Location"
@@ -1791,16 +1973,46 @@
},
"id": "GooglePrivacyDlpV2beta1RecordSuppression"
},
- "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.",
+ "GooglePrivacyDlpV2beta1InfoTypeDescription": {
+ "description": "Description of the information type (infoType).",
"type": "object",
"properties": {
- "field": {
- "description": "Composite key indicating which field contains the entity identifier.",
- "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ "displayName": {
+ "description": "Human readable form of the infoType name.",
+ "type": "string"
+ },
+ "categories": {
+ "description": "List of categories this infoType belongs to.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1CategoryDescription"
+ }
+ },
+ "name": {
+ "description": "Internal name of the infoType.",
+ "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1EntityId"
+ "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": {
+ "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": {
+ "description": "Dictionary-based custom info type.",
+ "$ref": "GooglePrivacyDlpV2beta1Dictionary"
+ },
+ "surrogateType": {
+ "$ref": "GooglePrivacyDlpV2beta1SurrogateType",
+ "description": "Surrogate 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.",
@@ -1814,55 +2026,21 @@
},
"id": "GooglePrivacyDlpV2beta1UnwrappedCryptoKey"
},
- "GooglePrivacyDlpV2beta1CustomInfoType": {
- "properties": {
- "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": {
- "description": "Dictionary-based custom info type.",
- "$ref": "GooglePrivacyDlpV2beta1Dictionary"
- },
- "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"
- },
- "GooglePrivacyDlpV2beta1InfoTypeDescription": {
- "description": "Description of the information type (infoType).",
+ "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": {
- "categories": {
- "description": "List of categories this infoType belongs to.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1CategoryDescription"
- }
- },
- "name": {
- "description": "Internal name of the infoType.",
- "type": "string"
- },
- "displayName": {
- "description": "Human readable form of the infoType name.",
- "type": "string"
+ "field": {
+ "description": "Composite key indicating which field contains the entity identifier.",
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
}
},
- "id": "GooglePrivacyDlpV2beta1InfoTypeDescription"
+ "id": "GooglePrivacyDlpV2beta1EntityId"
},
"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": {
- "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"
- },
"table": {
"$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
"description": "Auxiliary table location. [required]"
@@ -1873,37 +2051,14 @@
"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"
},
- "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.",
- "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": "GoogleRpcStatus"
- },
"GooglePrivacyDlpV2beta1KMapEstimationResult": {
"description": "Result of the reidentifiability analysis. Note that these results are an\nestimation, not exact values.",
"type": "object",
@@ -1918,6 +2073,33 @@
},
"id": "GooglePrivacyDlpV2beta1KMapEstimationResult"
},
+ "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",
+ "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": "GoogleRpcStatus"
+ },
"GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues": {
"description": "A tuple of values for the quasi-identifier columns.",
"type": "object",
@@ -1938,15 +2120,9 @@
"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": {
- "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"
@@ -1954,27 +2130,14 @@
"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"
- }
- }
- },
- "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": {
- "tableId": {
- "description": "Name of the table.",
- "type": "string"
},
- "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.",
+ "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"
}
},
- "id": "GooglePrivacyDlpV2beta1BigQueryTable"
+ "id": "GooglePrivacyDlpV2beta1PathElement"
},
"GooglePrivacyDlpV2beta1SummaryResult": {
"description": "A collection that informs the user the number of times a particular\n`TransformationResultCode` and error details occurred.",
@@ -2004,19 +2167,24 @@
},
"id": "GooglePrivacyDlpV2beta1SummaryResult"
},
- "GooglePrivacyDlpV2beta1InfoTypeTransformations": {
- "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.",
+ "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": {
- "transformations": {
- "description": "Transformation for each info type. Cannot specify more than one\nfor a given info type. [required]",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformation"
- }
+ "tableId": {
+ "description": "Name of the table.",
+ "type": "string"
+ },
+ "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"
}
},
- "id": "GooglePrivacyDlpV2beta1InfoTypeTransformations"
+ "id": "GooglePrivacyDlpV2beta1BigQueryTable"
},
"GooglePrivacyDlpV2beta1ListRootCategoriesResponse": {
"description": "Response for ListRootCategories request.",
@@ -2032,6 +2200,20 @@
},
"id": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse"
},
+ "GooglePrivacyDlpV2beta1InfoTypeTransformations": {
+ "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 info type. Cannot specify more than one\nfor a given info type. [required]",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformation"
+ }
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta1InfoTypeTransformations"
+ },
"GooglePrivacyDlpV2beta1KindExpression": {
"description": "A representation of a Datastore kind.",
"type": "object",
@@ -2042,194 +2224,12 @@
}
},
"id": "GooglePrivacyDlpV2beta1KindExpression"
- },
- "GooglePrivacyDlpV2beta1FileSet": {
- "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."
- },
- "GooglePrivacyDlpV2beta1InfoTypeTransformation": {
- "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",
- "description": "A transformation to apply to text that is identified as a specific\ninfo_type.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest": {
- "type": "object",
- "properties": {
- "sourceTable": {
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
- "description": "Input dataset to compute metrics over."
- },
- "privacyMetric": {
- "description": "Privacy metric to compute.",
- "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric"
- }
- },
- "id": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest",
- "description": "Request for creating a risk analysis operation."
- },
- "GooglePrivacyDlpV2beta1Bucket": {
- "description": "Buckets represented as ranges, along with replacement values. Ranges must\nbe non-overlapping.",
- "type": "object",
- "properties": {
- "max": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "Upper bound of the range, exclusive; type must match min."
- },
- "replacementValue": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "Replacement value for this bucket. If not provided\nthe default behavior will be to hyphenate the min-max range."
- },
- "min": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "Lower bound of the range, inclusive. Type should be the same as max if\nused."
- }
- },
- "id": "GooglePrivacyDlpV2beta1Bucket"
- },
- "GooglePrivacyDlpV2beta1KAnonymityResult": {
- "description": "Result of the k-anonymity computation.",
- "type": "object",
- "properties": {
- "equivalenceClassHistogramBuckets": {
- "description": "Histogram of k-anonymity equivalence classes.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1KAnonymityResult"
- },
- "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket": {
- "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": {
- "description": "Lower bound on the value frequency of the values in this bucket.",
- "format": "int64",
- "type": "string"
- },
- "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"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket",
- "description": "Histogram bucket of value frequencies in the column.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta1TableLocation": {
- "properties": {
- "rowIndex": {
- "description": "The zero-based index of the row where the finding is located.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1TableLocation",
- "description": "Location of a finding within a `ContentItem.Table`.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta1KAnonymityConfig": {
- "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"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1KAnonymityConfig"
- },
- "GooglePrivacyDlpV2beta1DatastoreKey": {
- "description": "Record key for a finding in Cloud Datastore.",
- "type": "object",
- "properties": {
- "entityKey": {
- "description": "Datastore entity key.",
- "$ref": "GooglePrivacyDlpV2beta1Key"
- }
- },
- "id": "GooglePrivacyDlpV2beta1DatastoreKey"
- },
- "GooglePrivacyDlpV2beta1RecordKey": {
- "description": "Message for a unique key indicating a record that contains a finding.",
- "type": "object",
- "properties": {
- "cloudStorageKey": {
- "$ref": "GooglePrivacyDlpV2beta1CloudStorageKey"
- },
- "datastoreKey": {
- "$ref": "GooglePrivacyDlpV2beta1DatastoreKey"
- }
- },
- "id": "GooglePrivacyDlpV2beta1RecordKey"
- },
- "GooglePrivacyDlpV2beta1DeidentifyContentRequest": {
- "description": "Request to de-identify a list of items.",
- "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.\nAll items will be treated as text/*.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1ContentItem"
- }
- },
- "deidentifyConfig": {
- "$ref": "GooglePrivacyDlpV2beta1DeidentifyConfig",
- "description": "Configuration for the de-identification of the list of content items."
- }
- },
- "id": "GooglePrivacyDlpV2beta1DeidentifyContentRequest"
}
},
"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": "DLP",
"auth": {
@@ -2249,191 +2249,71 @@
"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": {
- "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.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1InspectContentResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/content:inspect",
- "path": "v2beta1/content:inspect",
- "id": "dlp.content.inspect"
- },
- "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": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "languageCode": {
- "type": "string",
- "location": "query",
- "description": "Optional language code for localized friendly category names.\nIf omitted or if localized strings are not available,\nen-US strings will be returned."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/rootCategories",
- "path": "v2beta1/rootCategories",
- "id": "dlp.rootCategories.list",
- "description": "Returns the list of root categories of sensitive information."
- }
- },
+ "inspect": {
"resources": {
- "infoTypes": {
- "methods": {
- "list": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1ListInfoTypesResponse"
- },
- "parameterOrder": [
- "category"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "category": {
- "pattern": "^[^/]+$",
- "location": "path",
- "description": "Category name as returned by ListRootCategories.",
- "required": true,
- "type": "string"
+ "results": {
+ "resources": {
+ "findings": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "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."
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/rootCategories/{rootCategoriesId}/infoTypes",
- "path": "v2beta1/rootCategories/{+category}/infoTypes",
- "id": "dlp.rootCategories.infoTypes.list",
- "description": "Returns sensitive information types for given category."
+ }
}
}
- }
- }
- },
- "riskAnalysis": {
- "resources": {
+ },
"operations": {
"methods": {
- "cancel": {
- "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",
- "request": {
- "$ref": "GoogleLongrunningCancelOperationRequest"
- },
- "description": "Cancels an operation. Use the `inspect.operations.get` to check whether the cancellation succeeded or the operation completed despite cancellation."
- },
- "delete": {
- "path": "v2beta1/{+name}",
- "id": "dlp.riskAnalysis.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": {
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string",
- "pattern": "^riskAnalysis/operations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}"
- },
"list": {
+ "flatPath": "v2beta1/inspect/operations",
+ "id": "dlp.inspect.operations.list",
+ "path": "v2beta1/{+name}",
"description": "Fetches the list of long running operations.",
"httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
- "parameterOrder": [
- "name"
- ],
"parameters": {
"filter": {
"description": "Filters by `done`. That is, `done=true` or `done=false`.",
@@ -2441,11 +2321,11 @@
"location": "query"
},
"name": {
- "pattern": "^riskAnalysis/operations$",
- "location": "path",
"description": "The name of the operation's parent resource.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^inspect/operations$",
+ "location": "path"
},
"pageToken": {
"location": "query",
@@ -2453,18 +2333,15 @@
"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"
+ "type": "integer",
+ "location": "query"
}
},
"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.",
@@ -2480,185 +2357,36 @@
],
"parameters": {
"name": {
- "pattern": "^riskAnalysis/operations/[^/]+$",
- "location": "path",
"description": "The name of the operation resource.",
"required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}",
- "path": "v2beta1/{+name}",
- "id": "dlp.riskAnalysis.operations.get"
- }
- }
- }
- }
- },
- "dataSource": {
- "methods": {
- "analyze": {
- "flatPath": "v2beta1/dataSource:analyze",
- "path": "v2beta1/dataSource:analyze",
- "id": "dlp.dataSource.analyze",
- "description": "Schedules a job to compute risk analysis metrics over content in a Google\nCloud Platform repository.",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest"
- },
- "response": {
- "$ref": "GoogleLongrunningOperation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {}
- }
- }
- },
- "inspect": {
- "resources": {
- "results": {
- "resources": {
- "findings": {
- "methods": {
- "list": {
- "description": "Returns list of results for given inspect operation result set id.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse"
- },
- "parameters": {
- "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": {
- "type": "string",
- "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."
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of results to return.\nIf 0, the implementation selects a reasonable value.",
- "format": "int32",
- "type": "integer"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/inspect/results/{resultsId}/findings",
- "id": "dlp.inspect.results.findings.list",
- "path": "v2beta1/{+name}/findings"
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "id": "dlp.inspect.operations.list",
- "path": "v2beta1/{+name}",
- "description": "Fetches the list of long running operations.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleLongrunningListOperationsResponse"
- },
- "parameters": {
- "name": {
- "description": "The name of the operation's parent resource.",
- "required": true,
"type": "string",
- "pattern": "^inspect/operations$",
+ "pattern": "^inspect/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"
- },
- "filter": {
- "location": "query",
- "description": "Filters by `done`. That is, `done=true` or `done=false`.",
- "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta1/inspect/operations"
+ "flatPath": "v2beta1/inspect/operations/{operationsId}",
+ "path": "v2beta1/{+name}",
+ "id": "dlp.inspect.operations.get"
},
- "get": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "GoogleLongrunningOperation"
},
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^inspect/operations/[^/]+$"
- }
- },
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "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": {
"flatPath": "v2beta1/inspect/operations",
- "path": "v2beta1/inspect/operations",
"id": "dlp.inspect.operations.create",
- "description": "Schedules a job scanning content in a Google Cloud Platform data\nrepository.",
+ "path": "v2beta1/inspect/operations",
"request": {
"$ref": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest"
},
- "response": {
- "$ref": "GoogleLongrunningOperation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {}
+ "description": "Schedules a job scanning content in a Google Cloud Platform data\nrepository."
},
"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"
},
@@ -2671,18 +2399,23 @@
],
"parameters": {
"name": {
+ "location": "path",
"description": "The name of the operation resource to be cancelled.",
"required": true,
"type": "string",
- "pattern": "^inspect/operations/[^/]+$",
- "location": "path"
+ "pattern": "^inspect/operations/[^/]+$"
}
},
"flatPath": "v2beta1/inspect/operations/{operationsId}:cancel",
"path": "v2beta1/{+name}:cancel",
- "id": "dlp.inspect.operations.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"
+ }
},
"delete": {
+ "flatPath": "v2beta1/inspect/operations/{operationsId}",
"path": "v2beta1/{+name}",
"id": "dlp.inspect.operations.delete",
"description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
@@ -2704,30 +2437,307 @@
"pattern": "^inspect/operations/[^/]+$",
"location": "path"
}
- },
- "flatPath": "v2beta1/inspect/operations/{operationsId}"
+ }
}
}
}
}
+ },
+ "content": {
+ "methods": {
+ "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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1InspectContentResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v2beta1/content:inspect",
+ "id": "dlp.content.inspect",
+ "path": "v2beta1/content:inspect"
+ },
+ "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",
+ "id": "dlp.content.redact",
+ "path": "v2beta1/content:redact"
+ },
+ "deidentify": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta1DeidentifyContentResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta1/content:deidentify",
+ "id": "dlp.content.deidentify",
+ "path": "v2beta1/content:deidentify",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta1DeidentifyContentRequest"
+ },
+ "description": "De-identifies potentially sensitive info from a list of strings.\nThis method has limits on input size 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": {
+ "location": "query",
+ "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"
+ }
+ },
+ "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": {
+ "location": "path",
+ "description": "Category name as returned by ListRootCategories.",
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+$"
+ },
+ "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": {
+ "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": "^riskAnalysis/operations/[^/]+$"
+ }
+ },
+ "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": {
+ "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}",
+ "path": "v2beta1/{+name}",
+ "id": "dlp.riskAnalysis.operations.delete",
+ "description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
+ "response": {
+ "$ref": "GoogleProtobufEmpty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string",
+ "pattern": "^riskAnalysis/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "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": {
+ "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"
+ }
+ },
+ "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"
+ }
+ }
}
},
"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": {
- "type": "boolean",
- "default": "true",
"location": "query",
- "description": "Returns response with indentations and line breaks."
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "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": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
@@ -2735,38 +2745,38 @@
"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.",
- "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"
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
},
"access_token": {
"location": "query",
@@ -2774,9 +2784,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."
+ "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.",
@@ -2788,22 +2798,12 @@
"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": "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": "",
+ "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": ""
}
diff --git a/dlp/v2beta2/dlp-api.json b/dlp/v2beta2/dlp-api.json
index 43b0aeb..3f468ca 100644
--- a/dlp/v2beta2/dlp-api.json
+++ b/dlp/v2beta2/dlp-api.json
@@ -1,4 +1,1046 @@
{
+ "canonicalName": "DLP",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://dlp.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "dlp",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "DLP API",
+ "ownerName": "Google",
+ "resources": {
+ "infoTypes": {
+ "methods": {
+ "list": {
+ "path": "v2beta2/infoTypes",
+ "id": "dlp.infoTypes.list",
+ "description": "Returns sensitive information types DLP supports.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2ListInfoTypesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/infoTypes"
+ }
+ }
+ },
+ "organizations": {
+ "resources": {
+ "inspectTemplates": {
+ "methods": {
+ "delete": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}",
+ "id": "dlp.organizations.inspectTemplates.delete",
+ "path": "v2beta2/{+name}",
+ "description": "Deletes inspect templates.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "GoogleProtobufEmpty"
+ },
+ "parameterOrder": [
+ "name"
+ ]
+ },
+ "patch": {
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}",
+ "path": "v2beta2/{+name}",
+ "id": "dlp.organizations.inspectTemplates.patch",
+ "description": "Updates the inspect template.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest"
+ }
+ },
+ "get": {
+ "path": "v2beta2/{+name}",
+ "id": "dlp.organizations.inspectTemplates.get",
+ "description": "Gets an inspect template.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "Resource name of the organization and inspectTemplate to be read, 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}"
+ },
+ "list": {
+ "id": "dlp.organizations.inspectTemplates.list",
+ "path": "v2beta2/{+parent}/inspectTemplates",
+ "description": "Lists inspect templates.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "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"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates"
+ },
+ "create": {
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest"
+ },
+ "description": "Creates an inspect template for re-using frequently used configuration\nfor inspecting content, images, and storage.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
+ },
+ "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}/inspectTemplates",
+ "id": "dlp.organizations.inspectTemplates.create",
+ "path": "v2beta2/{+parent}/inspectTemplates"
+ }
+ }
+ },
+ "deidentifyTemplates": {
+ "methods": {
+ "create": {
+ "path": "v2beta2/{+parent}/deidentifyTemplates",
+ "id": "dlp.organizations.deidentifyTemplates.create",
+ "description": "Creates an Deidentify template for re-using frequently used configuration\nfor Deidentifying content, images, and storage.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest"
+ },
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
+ },
+ "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 or\norganizations/my-org-id.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates"
+ },
+ "delete": {
+ "path": "v2beta2/{+name}",
+ "id": "dlp.organizations.deidentifyTemplates.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/deidentifyTemplates/432452342`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}"
+ },
+ "patch": {
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$",
+ "location": "path",
+ "description": "Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}",
+ "path": "v2beta2/{+name}",
+ "id": "dlp.organizations.deidentifyTemplates.patch",
+ "description": "Updates the inspect template.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest"
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "Resource name of the organization and inspectTemplate to be read, for\nexample `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}",
+ "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": {
+ "description": "Optional page token to continue retrieval. Comes from previous call\nto `ListDeidentifyTemplates`.",
+ "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"
+ },
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "deidentifyTemplates": {
+ "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/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",
+ "description": "Deletes inspect templates."
+ },
+ "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 inspectTemplate 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": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$",
+ "location": "path",
+ "description": "Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ },
+ "list": {
+ "parameters": {
+ "pageToken": {
+ "description": "Optional page token to continue retrieval. Comes from previous call\nto `ListDeidentifyTemplates`.",
+ "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"
+ },
+ "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",
+ "path": "v2beta2/{+parent}/deidentifyTemplates",
+ "id": "dlp.projects.deidentifyTemplates.list",
+ "description": "Lists inspect templates.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET"
+ },
+ "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}/deidentifyTemplates",
+ "path": "v2beta2/{+parent}/deidentifyTemplates",
+ "id": "dlp.projects.deidentifyTemplates.create",
+ "description": "Creates an Deidentify template for re-using frequently used configuration\nfor Deidentifying content, images, and storage.",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest"
+ },
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST"
+ }
+ }
+ },
+ "image": {
+ "methods": {
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "dlpJobs": {
+ "methods": {
+ "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",
+ "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"
+ },
+ "list": {
+ "path": "v2beta2/{+parent}/dlpJobs",
+ "id": "dlp.projects.dlpJobs.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": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The parent resource name, for example projects/my-project-id.",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "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",
+ "location": "query"
+ },
+ "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": {
+ "description": "The type of job. Defaults to `DlpJobType.INSPECT`",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "DLP_JOB_TYPE_UNSPECIFIED",
+ "INSPECT_JOB",
+ "RISK_ANALYSIS_JOB"
+ ]
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/dlpJobs"
+ },
+ "get": {
+ "description": "Gets the latest state of a long-running DlpJob.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DlpJob"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/dlpJobs/[^/]+$",
+ "location": "path",
+ "description": "The name of the DlpJob resource.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/dlpJobs/{dlpJobsId}",
+ "path": "v2beta2/{+name}",
+ "id": "dlp.projects.dlpJobs.get"
+ },
+ "cancel": {
+ "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",
+ "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."
+ }
+ }
+ },
+ "inspectTemplates": {
+ "methods": {
+ "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": "^projects/[^/]+/inspectTemplates/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
+ "path": "v2beta2/{+name}",
+ "id": "dlp.projects.inspectTemplates.delete"
+ },
+ "patch": {
+ "path": "v2beta2/{+name}",
+ "id": "dlp.projects.inspectTemplates.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}"
+ },
+ "get": {
+ "path": "v2beta2/{+name}",
+ "id": "dlp.projects.inspectTemplates.get",
+ "description": "Gets an inspect template.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}"
+ },
+ "list": {
+ "description": "Lists inspect templates.",
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": {
+ "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.list"
+ },
+ "create": {
+ "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}/inspectTemplates",
+ "id": "dlp.projects.inspectTemplates.create",
+ "path": "v2beta2/{+parent}/inspectTemplates",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest"
+ },
+ "description": "Creates an inspect template for re-using frequently used configuration\nfor inspecting content, images, and storage.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
+ }
+ }
+ }
+ },
+ "content": {
+ "methods": {
+ "reidentify": {
+ "id": "dlp.projects.content.reidentify",
+ "path": "v2beta2/{+parent}/content:reidentify",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2ReidentifyContentRequest"
+ },
+ "description": "Re-identify content that has been de-identified.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2ReidentifyContentResponse"
+ },
+ "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"
+ },
+ "deidentify": {
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyContentResponse"
+ },
+ "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:deidentify",
+ "path": "v2beta2/{+parent}/content:deidentify",
+ "id": "dlp.projects.content.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"
+ }
+ },
+ "inspect": {
+ "id": "dlp.projects.content.inspect",
+ "path": "v2beta2/{+parent}/content:inspect",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectContentRequest"
+ },
+ "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)",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectContentResponse"
+ },
+ "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}/content:inspect"
+ }
+ }
+ },
+ "dataSource": {
+ "methods": {
+ "inspect": {
+ "description": "Schedules a job scanning content in a Google Cloud Platform data\nrepository. [How-to guide](/dlp/docs/inspecting-storage)",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectDataSourceRequest"
+ },
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DlpJob"
+ },
+ "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}/dataSource:inspect",
+ "path": "v2beta2/{+parent}/dataSource:inspect",
+ "id": "dlp.projects.dataSource.inspect"
+ },
+ "analyze": {
+ "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)",
+ "request": {
+ "$ref": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest"
+ },
+ "response": {
+ "$ref": "GooglePrivacyDlpV2beta2DlpJob"
+ },
+ "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}/dataSource:analyze",
+ "path": "v2beta2/{+parent}/dataSource:analyze",
+ "id": "dlp.projects.dataSource.analyze"
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "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": "20171212",
"documentationLink": "https://cloud.google.com/dlp/docs/",
@@ -6,632 +1048,27 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "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"
- },
- "GooglePrivacyDlpV2beta2KMapEstimationHistogramBucket": {
- "properties": {
- "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"
- },
- "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"
- }
- }
- },
- "id": "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"
- },
- "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": {
- "description": "The resource name of the KMS CryptoKey to use for unwrapping. [required]",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2KmsWrappedCryptoKey"
- },
- "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"
- },
- "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": {
- "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": "GooglePrivacyDlpV2beta2InfoTypeStatistics"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta2Result",
- "type": "object"
- },
- "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": {
- "description": "Surrogate info type.",
- "$ref": "GooglePrivacyDlpV2beta2SurrogateType"
- },
- "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": {
- "$ref": "GooglePrivacyDlpV2beta2Dictionary",
- "description": "Dictionary-based custom info type."
- }
- },
- "id": "GooglePrivacyDlpV2beta2CustomInfoType"
- },
- "GooglePrivacyDlpV2beta2DeidentifyContentResponse": {
- "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",
- "description": "Results of de-identifying a ContentItem.",
- "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": {
- "description": "The custom info type to annotate the surrogate with.\nThis annotation will be applied to the surrogate by prefixing it with\nthe name of the custom info type 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 info type 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 info type\n[`SurrogateType`](/dlp/docs/reference/rest/v2beta1/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 info type 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 info type 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",
- "$ref": "GooglePrivacyDlpV2beta2InfoType"
- },
- "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"
- },
- "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": {
- "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"
- },
- "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`.",
- "type": "object",
- "properties": {},
- "id": "GooglePrivacyDlpV2beta1SurrogateType"
- },
- "GooglePrivacyDlpV2beta1ValueFrequency": {
- "properties": {
- "count": {
- "description": "How many times the value is contained in the field.",
- "format": "int64",
- "type": "string"
- },
- "value": {
- "description": "A value contained in the field in question.",
- "$ref": "GooglePrivacyDlpV2beta1Value"
- }
- },
- "id": "GooglePrivacyDlpV2beta1ValueFrequency",
- "description": "A value of a field, including its frequency.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta2FindingLimits": {
- "properties": {
- "maxFindingsPerInfoType": {
- "description": "Configuration of findings limit given for specified info types.",
- "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",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta1InfoTypeLimit": {
- "properties": {
- "maxFindings": {
- "description": "Max findings limit for the given infoType.",
- "format": "int32",
- "type": "integer"
- },
- "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"
- }
- },
- "id": "GooglePrivacyDlpV2beta1InfoTypeLimit",
- "description": "Max findings configuration per info type, per content item or long running\noperation.",
- "type": "object"
- },
- "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": {
- "$ref": "GooglePrivacyDlpV2beta2InspectDataSourceDetails",
- "description": "Results from inspecting a data source."
- },
- "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"
- ],
- "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": {
- "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."
- ]
- }
- },
- "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": {
- "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"
- },
- "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": {
- "description": "List of words or phrases to search for.",
- "$ref": "GooglePrivacyDlpV2beta2WordList"
- }
- },
- "id": "GooglePrivacyDlpV2beta2Dictionary"
- },
- "GooglePrivacyDlpV2beta1Value": {
- "properties": {
- "dateValue": {
- "$ref": "GoogleTypeDate"
- },
- "timestampValue": {
- "format": "google-datetime",
- "type": "string"
- },
- "booleanValue": {
- "type": "boolean"
- },
- "floatValue": {
- "format": "double",
- "type": "number"
- },
- "integerValue": {
- "format": "int64",
- "type": "string"
- },
- "timeValue": {
- "$ref": "GoogleTypeTimeOfDay"
- },
- "stringValue": {
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1Value",
- "description": "Set of primitive values supported by the system.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta2RecordCondition": {
- "properties": {
- "expressions": {
- "$ref": "GooglePrivacyDlpV2beta2Expressions"
- }
- },
- "id": "GooglePrivacyDlpV2beta2RecordCondition",
- "description": "A condition for determining whether a transformation should be applied to\na field.",
- "type": "object"
- },
- "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": {
- "properties": {
- "name": {
- "description": "The name of the kind.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2KindExpression",
- "description": "A representation of a Datastore kind.",
- "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.",
- "type": "object",
- "properties": {
- "projectId": {
- "description": "The ID of the project to which the entities belong.",
- "type": "string"
- },
- "namespaceId": {
- "description": "If not empty, the ID of the namespace to which the entities belong.",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta1PartitionId"
- },
- "GooglePrivacyDlpV2beta2InspectResult": {
- "description": "All the findings for a single scanned item.",
- "type": "object",
- "properties": {
- "findings": {
- "description": "List of findings for an item.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2Finding"
- }
- },
- "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"
- }
- },
- "id": "GooglePrivacyDlpV2beta2InspectResult"
- },
- "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",
- "properties": {
- "cryptoKey": {
- "description": "The key used by the hash function.",
- "$ref": "GooglePrivacyDlpV2beta2CryptoKey"
- }
- },
- "id": "GooglePrivacyDlpV2beta2CryptoHashConfig"
- },
- "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": [
- "",
- "[000-9999]",
- "[1-12]",
- "[1-31]",
- "[1-7]",
- "[1-52]",
- "[0-24]"
- ]
- }
- },
- "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": {
- "description": "Bounding box encompassing detected text within an image.",
- "type": "object",
- "properties": {
- "width": {
- "description": "Width of the bounding box in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "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"
- }
- },
- "id": "GooglePrivacyDlpV2beta2ImageLocation"
- },
- "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": {
- "properties": {
- "inspectTemplate": {
- "description": "New InspectTemplate value.",
- "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
- },
- "updateMask": {
- "description": "Mask to control which fields get updated.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest",
- "description": "Request message for UpdateInspectTemplate.",
- "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": "A collection of expressions",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta2InspectDataSourceRequest": {
- "properties": {
- "jobConfig": {
- "$ref": "GooglePrivacyDlpV2beta2InspectJobConfig"
- }
- },
- "id": "GooglePrivacyDlpV2beta2InspectDataSourceRequest",
- "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.",
- "type": "object"
- },
"GooglePrivacyDlpV2beta2TransformationSummary": {
"description": "Summary of a single tranformation.",
"type": "object",
"properties": {
+ "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. This list will contain\nmultiple entries only in the case of errors.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2FieldTransformation"
+ }
+ },
"recordSuppress": {
"$ref": "GooglePrivacyDlpV2beta2RecordSuppression",
"description": "The specific suppression option these stats apply to."
@@ -641,36 +1078,20 @@
"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. This list will contain\nmultiple entries only in the case of errors.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2FieldTransformation"
- }
+ "description": "The specific transformation these stats apply to.",
+ "$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation"
}
},
"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].",
- "$ref": "GooglePrivacyDlpV2beta2Value"
+ "$ref": "GooglePrivacyDlpV2beta2Value",
+ "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": "GooglePrivacyDlpV2beta2Value",
@@ -681,14 +1102,13 @@
"format": "double",
"type": "number"
}
- },
- "id": "GooglePrivacyDlpV2beta2FixedSizeBucketingConfig"
+ }
},
"GooglePrivacyDlpV2beta2CancelDlpJobRequest": {
- "properties": {},
- "id": "GooglePrivacyDlpV2beta2CancelDlpJobRequest",
"description": "The request message for canceling a DLP job.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "GooglePrivacyDlpV2beta2CancelDlpJobRequest"
},
"GooglePrivacyDlpV2beta2Row": {
"type": "object",
@@ -740,14 +1160,21 @@
"type": "string"
},
"location": {
- "description": "Location of the info found.",
- "$ref": "GooglePrivacyDlpV2beta2Location"
+ "$ref": "GooglePrivacyDlpV2beta2Location",
+ "description": "Location of the info found."
}
},
"id": "GooglePrivacyDlpV2beta2Finding"
},
"GooglePrivacyDlpV2beta1TaggedField": {
+ "id": "GooglePrivacyDlpV2beta1TaggedField",
+ "description": "A column with a semantic tag attached.",
+ "type": "object",
"properties": {
+ "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"
@@ -759,15 +1186,8 @@
"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",
- "description": "A column with a semantic tag attached.",
- "type": "object"
+ }
},
"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.",
@@ -784,33 +1204,23 @@
},
"id": "GooglePrivacyDlpV2beta2PartitionId"
},
- "GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues": {
+ "GooglePrivacyDlpV2beta2Conditions": {
+ "type": "object",
"properties": {
- "quasiIdsValues": {
- "description": "The quasi-identifier values.",
+ "conditions": {
"type": "array",
"items": {
- "$ref": "GooglePrivacyDlpV2beta2Value"
+ "$ref": "GooglePrivacyDlpV2beta2Condition"
}
- },
- "estimatedAnonymity": {
- "description": "The estimated anonymity for these quasi-identifier values.",
- "format": "int64",
- "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues",
- "description": "A tuple of values for the quasi-identifier columns.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2Conditions"
},
"GooglePrivacyDlpV2beta2CharacterMaskConfig": {
+ "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",
"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"
@@ -826,43 +1236,40 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta2CharsToIgnore"
}
+ },
+ "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"
}
- },
- "id": "GooglePrivacyDlpV2beta2CharacterMaskConfig"
+ }
},
- "GooglePrivacyDlpV2beta2Conditions": {
+ "GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues": {
+ "id": "GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues",
+ "description": "A tuple of values for the quasi-identifier columns.",
"type": "object",
"properties": {
- "conditions": {
+ "quasiIdsValues": {
+ "description": "The quasi-identifier values.",
"type": "array",
"items": {
- "$ref": "GooglePrivacyDlpV2beta2Condition"
+ "$ref": "GooglePrivacyDlpV2beta2Value"
}
- }
- },
- "id": "GooglePrivacyDlpV2beta2Conditions"
- },
- "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse": {
- "properties": {
- "nextPageToken": {
- "description": "If the next page is available then the next page token to be used\nin following ListDeidentifyTemplates request.",
- "type": "string"
},
- "deidentifyTemplates": {
- "description": "List of deidentifyTemplates, up to page_size in\nListDeidentifyTemplatesRequest.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- }
+ "estimatedAnonymity": {
+ "description": "The estimated anonymity for these quasi-identifier values.",
+ "format": "int64",
+ "type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse",
- "description": "Response message for ListDeidentifyTemplates.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta2InspectJobConfig": {
+ "id": "GooglePrivacyDlpV2beta2InspectJobConfig",
"type": "object",
"properties": {
+ "outputConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2OutputStorageConfig",
+ "description": "Where to put the findings."
+ },
"inspectConfig": {
"$ref": "GooglePrivacyDlpV2beta2InspectConfig",
"description": "How and what to scan for."
@@ -874,51 +1281,64 @@
"storageConfig": {
"description": "The data to scan.",
"$ref": "GooglePrivacyDlpV2beta2StorageConfig"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse": {
+ "description": "Response message for ListDeidentifyTemplates.",
+ "type": "object",
+ "properties": {
+ "deidentifyTemplates": {
+ "description": "List of deidentifyTemplates, up to page_size in\nListDeidentifyTemplatesRequest.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
+ }
},
- "outputConfig": {
- "$ref": "GooglePrivacyDlpV2beta2OutputStorageConfig",
- "description": "Where to put the findings."
+ "nextPageToken": {
+ "description": "If the next page is available then the next page token to be used\nin following ListDeidentifyTemplates request.",
+ "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2InspectJobConfig"
+ "id": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse"
},
"GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest": {
+ "id": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest",
+ "description": "Request message for UpdateDeidentifyTemplate.",
+ "type": "object",
"properties": {
+ "deidentifyTemplate": {
+ "description": "New DeidentifyTemplate value.",
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
+ },
"updateMask": {
"description": "Mask to control which fields get updated.",
"format": "google-fieldmask",
"type": "string"
- },
- "deidentifyTemplate": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate",
- "description": "New DeidentifyTemplate value."
}
- },
- "id": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest",
- "description": "Request message for UpdateDeidentifyTemplate.",
- "type": "object"
+ }
+ },
+ "GooglePrivacyDlpV2beta2SurrogateType": {
+ "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`.",
+ "type": "object",
+ "properties": {}
},
"GooglePrivacyDlpV2beta2CryptoKey": {
+ "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",
"properties": {
- "kmsWrapped": {
- "$ref": "GooglePrivacyDlpV2beta2KmsWrappedCryptoKey"
- },
"unwrapped": {
"$ref": "GooglePrivacyDlpV2beta2UnwrappedCryptoKey"
},
"transient": {
"$ref": "GooglePrivacyDlpV2beta2TransientCryptoKey"
+ },
+ "kmsWrapped": {
+ "$ref": "GooglePrivacyDlpV2beta2KmsWrappedCryptoKey"
}
- },
- "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"
- },
- "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`.",
- "type": "object",
- "properties": {},
- "id": "GooglePrivacyDlpV2beta2SurrogateType"
+ }
},
"GooglePrivacyDlpV2beta1InfoTypeStatistics": {
"description": "Statistics regarding a specific InfoType.",
@@ -930,8 +1350,8 @@
"type": "string"
},
"infoType": {
- "description": "The type of finding this stat is for.",
- "$ref": "GooglePrivacyDlpV2beta1InfoType"
+ "$ref": "GooglePrivacyDlpV2beta1InfoType",
+ "description": "The type of finding this stat is for."
}
},
"id": "GooglePrivacyDlpV2beta1InfoTypeStatistics"
@@ -952,18 +1372,10 @@
},
"id": "GooglePrivacyDlpV2beta2CloudStorageKey"
},
- "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"
- },
"GooglePrivacyDlpV2beta2KAnonymityConfig": {
+ "id": "GooglePrivacyDlpV2beta2KAnonymityConfig",
+ "description": "k-anonymity metric, used for analysis of reidentification risk.",
+ "type": "object",
"properties": {
"entityId": {
"$ref": "GooglePrivacyDlpV2beta2EntityId",
@@ -976,12 +1388,22 @@
"$ref": "GooglePrivacyDlpV2beta2FieldId"
}
}
+ }
+ },
+ "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": "GooglePrivacyDlpV2beta2KAnonymityConfig",
- "description": "k-anonymity metric, used for analysis of reidentification risk.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1PropertyReference"
},
"GooglePrivacyDlpV2beta2InfoTypeDescription": {
+ "description": "Info type description.",
+ "type": "object",
"properties": {
"name": {
"description": "Internal name of the info type.",
@@ -992,32 +1414,16 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2InfoTypeDescription",
- "description": "Info type description.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta2InspectDataSourceDetails": {
- "description": "The results of an inspect DataSource job.",
- "type": "object",
- "properties": {
- "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"
+ "id": "GooglePrivacyDlpV2beta2InfoTypeDescription"
},
"GooglePrivacyDlpV2beta2ReidentifyContentRequest": {
+ "id": "GooglePrivacyDlpV2beta2ReidentifyContentRequest",
"description": "Request to re-identify an item.",
"type": "object",
"properties": {
"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`"
+ "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",
@@ -1028,17 +1434,32 @@
"type": "string"
},
"inspectConfig": {
- "$ref": "GooglePrivacyDlpV2beta2InspectConfig",
- "description": "Configuration for the inspector."
+ "description": "Configuration for the inspector.",
+ "$ref": "GooglePrivacyDlpV2beta2InspectConfig"
},
"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"
}
- },
- "id": "GooglePrivacyDlpV2beta2ReidentifyContentRequest"
+ }
+ },
+ "GooglePrivacyDlpV2beta2InspectDataSourceDetails": {
+ "id": "GooglePrivacyDlpV2beta2InspectDataSourceDetails",
+ "description": "The results of an inspect DataSource job.",
+ "type": "object",
+ "properties": {
+ "result": {
+ "$ref": "GooglePrivacyDlpV2beta2Result",
+ "description": "A summary of the outcome of this inspect job."
+ },
+ "requestedOptions": {
+ "$ref": "GooglePrivacyDlpV2beta2RequestedOptions",
+ "description": "The configuration used for this job."
+ }
+ }
},
"GooglePrivacyDlpV2beta2LDiversityResult": {
+ "id": "GooglePrivacyDlpV2beta2LDiversityResult",
"description": "Result of the l-diversity computation.",
"type": "object",
"properties": {
@@ -1049,10 +1470,21 @@
"$ref": "GooglePrivacyDlpV2beta2LDiversityHistogramBucket"
}
}
- },
- "id": "GooglePrivacyDlpV2beta2LDiversityResult"
+ }
+ },
+ "GooglePrivacyDlpV2beta2InspectContentResponse": {
+ "id": "GooglePrivacyDlpV2beta2InspectContentResponse",
+ "description": "Results of inspecting an item.",
+ "type": "object",
+ "properties": {
+ "result": {
+ "description": "The findings.",
+ "$ref": "GooglePrivacyDlpV2beta2InspectResult"
+ }
+ }
},
"GooglePrivacyDlpV2beta2Color": {
+ "id": "GooglePrivacyDlpV2beta2Color",
"description": "Represents a color in the RGB color space.",
"type": "object",
"properties": {
@@ -1071,36 +1503,26 @@
"format": "float",
"type": "number"
}
- },
- "id": "GooglePrivacyDlpV2beta2Color"
- },
- "GooglePrivacyDlpV2beta2InspectContentResponse": {
- "properties": {
- "result": {
- "$ref": "GooglePrivacyDlpV2beta2InspectResult",
- "description": "The findings."
- }
- },
- "id": "GooglePrivacyDlpV2beta2InspectContentResponse",
- "description": "Results of inspecting an item.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta1OutputStorageConfig": {
+ "id": "GooglePrivacyDlpV2beta1OutputStorageConfig",
"description": "Cloud repository for storing output.",
"type": "object",
"properties": {
- "table": {
- "description": "Store findings in a new table in the dataset.",
- "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
- },
"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"
+ },
+ "table": {
+ "description": "Store findings in a new table in the dataset.",
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
}
- },
- "id": "GooglePrivacyDlpV2beta1OutputStorageConfig"
+ }
},
"GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass": {
+ "description": "The set of columns' values that share the same k-anonymity value.",
+ "type": "object",
"properties": {
"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.",
@@ -1115,27 +1537,12 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass",
- "description": "The set of columns' values that share the same k-anonymity value.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta2DatastoreKey": {
- "description": "Record key for a finding in Cloud Datastore.",
- "type": "object",
- "properties": {
- "entityKey": {
- "$ref": "GooglePrivacyDlpV2beta2Key",
- "description": "Datastore entity key."
- }
- },
- "id": "GooglePrivacyDlpV2beta2DatastoreKey"
+ "id": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass"
},
"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": {
- "datasetId": {
- "description": "Dataset ID of the table.",
- "type": "string"
- },
"tableId": {
"description": "Name of the table.",
"type": "string"
@@ -1143,13 +1550,28 @@
"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"
}
},
- "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"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2DatastoreKey"
},
"GooglePrivacyDlpV2beta2RedactImageResponse": {
+ "description": "Results of redacting an image.",
+ "type": "object",
"properties": {
"redactedImage": {
"description": "The redacted image. The type will be the same as the original image.",
@@ -1161,86 +1583,87 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2RedactImageResponse",
- "description": "Results of redacting an image.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2RedactImageResponse"
},
"GooglePrivacyDlpV2beta1InspectOperationMetadata": {
+ "description": "Metadata returned within GetOperation for an inspect request.",
+ "type": "object",
"properties": {
+ "requestOutputConfig": {
+ "description": "Optional location to store findings.",
+ "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig"
+ },
+ "createTime": {
+ "description": "The time which this request was started.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"requestStorageConfig": {
- "description": "The storage config used to create the Operation.",
- "$ref": "GooglePrivacyDlpV2beta1StorageConfig"
+ "$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"
}
},
- "totalEstimatedBytes": {
- "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."
- },
- "requestOutputConfig": {
- "description": "Optional location to store findings.",
- "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig"
- },
- "createTime": {
- "description": "The time which this request was started.",
- "format": "google-datetime",
- "type": "string"
+ "description": "The inspect config used to create the Operation.",
+ "$ref": "GooglePrivacyDlpV2beta1InspectConfig"
}
},
- "id": "GooglePrivacyDlpV2beta1InspectOperationMetadata",
- "description": "Metadata returned within GetOperation for an inspect request.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1InspectOperationMetadata"
+ },
+ "GooglePrivacyDlpV2beta2RecordKey": {
+ "id": "GooglePrivacyDlpV2beta2RecordKey",
+ "description": "Message for a unique key indicating a record that contains a finding.",
+ "type": "object",
+ "properties": {
+ "cloudStorageKey": {
+ "$ref": "GooglePrivacyDlpV2beta2CloudStorageKey"
+ },
+ "datastoreKey": {
+ "$ref": "GooglePrivacyDlpV2beta2DatastoreKey"
+ }
+ }
},
"GooglePrivacyDlpV2beta1InfoType": {
+ "id": "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"
- },
- "GooglePrivacyDlpV2beta2RecordKey": {
- "description": "Message for a unique key indicating a record that contains a finding.",
- "type": "object",
- "properties": {
- "datastoreKey": {
- "$ref": "GooglePrivacyDlpV2beta2DatastoreKey"
- },
- "cloudStorageKey": {
- "$ref": "GooglePrivacyDlpV2beta2CloudStorageKey"
- }
- },
- "id": "GooglePrivacyDlpV2beta2RecordKey"
+ }
},
"GooglePrivacyDlpV2beta2EntityId": {
+ "id": "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.",
"type": "object",
"properties": {
"field": {
- "description": "Composite key indicating which field contains the entity identifier.",
- "$ref": "GooglePrivacyDlpV2beta2FieldId"
+ "$ref": "GooglePrivacyDlpV2beta2FieldId",
+ "description": "Composite key indicating which field contains the entity identifier."
}
- },
- "id": "GooglePrivacyDlpV2beta2EntityId"
+ }
},
"GooglePrivacyDlpV2beta2Bucket": {
+ "id": "GooglePrivacyDlpV2beta2Bucket",
+ "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.",
@@ -1251,31 +1674,36 @@
"description": "Upper bound of the range, exclusive; type must match min."
},
"replacementValue": {
- "description": "Replacement value for this bucket. If not provided\nthe default behavior will be to hyphenate the min-max range.",
- "$ref": "GooglePrivacyDlpV2beta2Value"
+ "$ref": "GooglePrivacyDlpV2beta2Value",
+ "description": "Replacement value for this bucket. If not provided\nthe default behavior will be to hyphenate the min-max range."
}
- },
- "id": "GooglePrivacyDlpV2beta2Bucket",
- "description": "Buckets represented as ranges, along with replacement values. Ranges must\nbe non-overlapping.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta2CreateInspectTemplateRequest": {
+ "id": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest",
+ "description": "Request message for CreateInspectTemplate.",
+ "type": "object",
"properties": {
- "inspectTemplate": {
- "description": "The InspectTemplate to create.",
- "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
- },
"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"
+ },
+ "inspectTemplate": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectTemplate",
+ "description": "The InspectTemplate to create."
}
- },
- "id": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest",
- "description": "Request message for CreateInspectTemplate.",
- "type": "object"
+ }
},
"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"
},
@@ -1284,31 +1712,29 @@
},
"kMapEstimationResult": {
"$ref": "GooglePrivacyDlpV2beta1KMapEstimationResult"
- },
- "kAnonymityResult": {
- "$ref": "GooglePrivacyDlpV2beta1KAnonymityResult"
- },
- "lDiversityResult": {
- "$ref": "GooglePrivacyDlpV2beta1LDiversityResult"
}
},
- "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationResult",
- "description": "Result of a risk analysis\n[`Operation`](/dlp/docs/reference/rest/v2beta1/inspect.operations)\nrequest.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationResult"
},
"GooglePrivacyDlpV2beta1CategoricalStatsConfig": {
+ "id": "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"
+ "$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"
+ }
},
"GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket": {
+ "type": "object",
"properties": {
+ "bucketSize": {
+ "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",
@@ -1325,22 +1751,15 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta2ValueFrequency"
}
- },
- "bucketSize": {
- "description": "Total number of values in this bucket.",
- "format": "int64",
- "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket"
},
"GooglePrivacyDlpV2beta1KMapEstimationConfig": {
+ "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",
"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",
@@ -1354,11 +1773,12 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta1TaggedField"
}
+ },
+ "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": "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"
+ }
},
"GooglePrivacyDlpV2beta2NumericalStatsResult": {
"description": "Result of the numerical stats computation.",
@@ -1369,8 +1789,8 @@
"description": "Minimum value appearing in the column."
},
"maxValue": {
- "$ref": "GooglePrivacyDlpV2beta2Value",
- "description": "Maximum value appearing in the column."
+ "description": "Maximum value appearing in the column.",
+ "$ref": "GooglePrivacyDlpV2beta2Value"
},
"quantileValues": {
"description": "List of 99 values that partition the set of field values into 100 equal\nsized buckets.",
@@ -1383,6 +1803,8 @@
"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.",
@@ -1390,47 +1812,44 @@
"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",
- "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": {
+ "field": {
+ "$ref": "GooglePrivacyDlpV2beta2FieldId",
+ "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"
},
"infoType": {
- "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.",
- "$ref": "GooglePrivacyDlpV2beta2InfoType"
+ "$ref": "GooglePrivacyDlpV2beta2InfoType",
+ "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"
- },
- "field": {
- "$ref": "GooglePrivacyDlpV2beta2FieldId",
- "description": "Identifies the column. [required]"
+ "$ref": "GoogleProtobufEmpty",
+ "description": "If no semantic tag is indicated, we infer the statistical model from\nthe distribution of values in the input data"
}
},
"id": "GooglePrivacyDlpV2beta2TaggedField"
},
"GooglePrivacyDlpV2beta2InspectContentRequest": {
+ "id": "GooglePrivacyDlpV2beta2InspectContentRequest",
+ "description": "Request to search for potentially sensitive info in a ContentItem.",
+ "type": "object",
"properties": {
- "item": {
- "description": "The item to inspect.",
- "$ref": "GooglePrivacyDlpV2beta2ContentItem"
- },
"inspectConfig": {
"description": "Configuration for the inspector. What specified here will override\nthe template referenced by the inspect_template_name argument.",
"$ref": "GooglePrivacyDlpV2beta2InspectConfig"
@@ -1438,14 +1857,25 @@
"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"
+ },
+ "item": {
+ "description": "The item to inspect.",
+ "$ref": "GooglePrivacyDlpV2beta2ContentItem"
}
- },
- "id": "GooglePrivacyDlpV2beta2InspectContentRequest",
- "description": "Request to search for potentially sensitive info in a ContentItem.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta2DeidentifyTemplate": {
+ "description": "The DeidentifyTemplates contains instructions on how to deidentify content.",
+ "type": "object",
"properties": {
+ "displayName": {
+ "description": "Display name (max 256 chars).",
+ "type": "string"
+ },
+ "description": {
+ "description": "Short description (max 256 chars).",
+ "type": "string"
+ },
"deidentifyConfig": {
"description": "///////////// // The core content of the template // ///////////////",
"$ref": "GooglePrivacyDlpV2beta2DeidentifyConfig"
@@ -1463,51 +1893,37 @@
"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"
- },
- "description": {
- "description": "Short description (max 256 chars).",
- "type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2DeidentifyTemplate",
- "description": "The DeidentifyTemplates contains instructions on how to deidentify content.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
},
"GooglePrivacyDlpV2beta2DatastoreOptions": {
+ "id": "GooglePrivacyDlpV2beta2DatastoreOptions",
+ "description": "Options defining a data set within Google Cloud Datastore.",
+ "type": "object",
"properties": {
- "kind": {
- "$ref": "GooglePrivacyDlpV2beta2KindExpression",
- "description": "The kind to process."
- },
"partitionId": {
"$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"
+ }
},
"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": {
- "inspectConfig": {
- "description": "///////////// // The core content of the template // ///////////////",
- "$ref": "GooglePrivacyDlpV2beta2InspectConfig"
+ "displayName": {
+ "description": "Display name (max 256 chars).",
+ "type": "string"
},
"description": {
"description": "Short description (max 256 chars).",
"type": "string"
},
- "displayName": {
- "description": "Display name (max 256 chars).",
- "type": "string"
- },
"createTime": {
"description": "The creation timestamp of a inspectTemplate, output only field.",
"format": "google-datetime",
@@ -1521,11 +1937,16 @@
"name": {
"description": "The template name. Output only.\n\nThe template will have one of the following formats:\n`projects/PROJECT_ID/inspectTemplates/TEMPLATE_ID` OR\n`organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`",
"type": "string"
+ },
+ "inspectConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectConfig",
+ "description": "///////////// // The core content of the template // ///////////////"
}
},
"id": "GooglePrivacyDlpV2beta2InspectTemplate"
},
"GooglePrivacyDlpV2beta2CharsToIgnore": {
+ "id": "GooglePrivacyDlpV2beta2CharsToIgnore",
"description": "Characters to skip when doing deidentification of a value. These will be left\nalone and skipped.",
"type": "object",
"properties": {
@@ -1533,6 +1954,7 @@
"type": "string"
},
"commonCharactersToIgnore": {
+ "type": "string",
"enumDescriptions": [
"",
"0-9",
@@ -1548,25 +1970,24 @@
"ALPHA_LOWER_CASE",
"PUNCTUATION",
"WHITESPACE"
- ],
- "type": "string"
+ ]
}
- },
- "id": "GooglePrivacyDlpV2beta2CharsToIgnore"
+ }
},
"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": {}
},
"GooglePrivacyDlpV2beta2RedactConfig": {
+ "id": "GooglePrivacyDlpV2beta2RedactConfig",
"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": "GooglePrivacyDlpV2beta2RedactConfig"
+ "properties": {}
},
"GooglePrivacyDlpV2beta2FieldId": {
+ "id": "GooglePrivacyDlpV2beta2FieldId",
"description": "General identifier of a data field in a storage service.",
"type": "object",
"properties": {
@@ -1574,50 +1995,56 @@
"description": "Name describing the field.",
"type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta2FieldId"
+ }
},
"GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest": {
+ "id": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest",
+ "description": "Request for creating a risk analysis DlpJob.",
+ "type": "object",
"properties": {
"jobConfig": {
"$ref": "GooglePrivacyDlpV2beta2RiskAnalysisJobConfig"
}
- },
- "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": {
+ "$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"
},
"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."
+ "description": "Configuration for the de-identification of the content item.\nItems specified here will override the template referenced by the\ndeidentify_template_name argument.",
+ "$ref": "GooglePrivacyDlpV2beta2DeidentifyConfig"
},
"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"
- },
- "item": {
- "description": "The item to de-identify. Will be treated as text.",
- "$ref": "GooglePrivacyDlpV2beta2ContentItem"
}
},
- "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",
@@ -1632,13 +2059,6 @@
"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"
@@ -1647,6 +2067,26 @@
"description": "Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.",
"type": "object",
"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",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "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",
@@ -1671,26 +2111,6 @@
"excludeInfoTypes": {
"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",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Only returns findings equal or above this threshold. The default is\nPOSSIBLE.",
- "type": "string"
}
},
"id": "GooglePrivacyDlpV2beta2InspectConfig"
@@ -1709,11 +2129,11 @@
"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": "GooglePrivacyDlpV2beta2FieldId"
- },
"customTag": {
"type": "string"
+ },
+ "field": {
+ "$ref": "GooglePrivacyDlpV2beta2FieldId"
}
},
"id": "GooglePrivacyDlpV2beta2QuasiIdField"
@@ -1726,16 +2146,16 @@
"$ref": "GooglePrivacyDlpV2beta2LDiversityResult"
},
"requestedSourceTable": {
- "$ref": "GooglePrivacyDlpV2beta2BigQueryTable",
- "description": "Input dataset to compute metrics over."
- },
- "categoricalStatsResult": {
- "$ref": "GooglePrivacyDlpV2beta2CategoricalStatsResult"
+ "description": "Input dataset to compute metrics over.",
+ "$ref": "GooglePrivacyDlpV2beta2BigQueryTable"
},
"requestedPrivacyMetric": {
"description": "Privacy metric to compute.",
"$ref": "GooglePrivacyDlpV2beta2PrivacyMetric"
},
+ "categoricalStatsResult": {
+ "$ref": "GooglePrivacyDlpV2beta2CategoricalStatsResult"
+ },
"numericalStatsResult": {
"$ref": "GooglePrivacyDlpV2beta2NumericalStatsResult"
},
@@ -1749,6 +2169,7 @@
"id": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails"
},
"GooglePrivacyDlpV2beta2BigQueryOptions": {
+ "id": "GooglePrivacyDlpV2beta2BigQueryOptions",
"description": "Options defining BigQuery table and row identifiers.",
"type": "object",
"properties": {
@@ -1760,24 +2181,25 @@
}
},
"tableReference": {
- "description": "Complete BigQuery table reference.",
- "$ref": "GooglePrivacyDlpV2beta2BigQueryTable"
+ "$ref": "GooglePrivacyDlpV2beta2BigQueryTable",
+ "description": "Complete BigQuery table reference."
}
- },
- "id": "GooglePrivacyDlpV2beta2BigQueryOptions"
+ }
},
"GooglePrivacyDlpV2beta1CloudStoragePath": {
+ "description": "A location in Cloud Storage.",
+ "type": "object",
"properties": {
"path": {
"description": "The url, in the format of `gs://bucket/\u003cpath\u003e`.",
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1CloudStoragePath",
- "description": "A location in Cloud Storage.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1CloudStoragePath"
},
"GooglePrivacyDlpV2beta2TransformationOverview": {
+ "description": "Overview of the modifications that occurred.",
+ "type": "object",
"properties": {
"transformedBytes": {
"description": "Total size in bytes that were transformed in some way.",
@@ -1792,9 +2214,7 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta2TransformationOverview",
- "description": "Overview of the modifications that occurred.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2TransformationOverview"
},
"GooglePrivacyDlpV2beta1InspectOperationResult": {
"description": "The operational data.",
@@ -1811,6 +2231,13 @@
"description": "Histogram bucket of equivalence class sizes in the table.",
"type": "object",
"properties": {
+ "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"
+ }
+ },
"equivalenceClassSizeLowerBound": {
"description": "Lower bound on the size of the equivalence classes in this bucket.",
"format": "int64",
@@ -1825,18 +2252,12 @@
"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"
},
"GooglePrivacyDlpV2beta2ListInspectTemplatesResponse": {
+ "id": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse",
"description": "Response message for ListInspectTemplates.",
"type": "object",
"properties": {
@@ -1851,10 +2272,12 @@
"$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
}
}
- },
- "id": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse"
+ }
},
"GooglePrivacyDlpV2beta1CategoricalStatsResult": {
+ "id": "GooglePrivacyDlpV2beta1CategoricalStatsResult",
+ "description": "Result of the categorical stats computation.",
+ "type": "object",
"properties": {
"valueFrequencyHistogramBuckets": {
"description": "Histogram of value frequencies in the column.",
@@ -1863,12 +2286,12 @@
"$ref": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket"
}
}
- },
- "id": "GooglePrivacyDlpV2beta1CategoricalStatsResult",
- "description": "Result of the categorical stats computation.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta1LDiversityResult": {
+ "id": "GooglePrivacyDlpV2beta1LDiversityResult",
+ "description": "Result of the l-diversity computation.",
+ "type": "object",
"properties": {
"sensitiveValueFrequencyHistogramBuckets": {
"description": "Histogram of l-diversity equivalence class sensitive value frequencies.",
@@ -1877,12 +2300,10 @@
"$ref": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket"
}
}
- },
- "id": "GooglePrivacyDlpV2beta1LDiversityResult",
- "description": "Result of the l-diversity computation.",
- "type": "object"
+ }
},
"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": {
@@ -1906,8 +2327,7 @@
"format": "int32",
"type": "integer"
}
- },
- "id": "GoogleTypeTimeOfDay"
+ }
},
"GooglePrivacyDlpV2beta2LDiversityEquivalenceClass": {
"description": "The set of columns' values that share the same ldiversity value.",
@@ -1941,15 +2361,15 @@
"id": "GooglePrivacyDlpV2beta2LDiversityEquivalenceClass"
},
"GooglePrivacyDlpV2beta2CategoricalStatsConfig": {
+ "id": "GooglePrivacyDlpV2beta2CategoricalStatsConfig",
"description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.",
"type": "object",
"properties": {
"field": {
- "$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."
+ "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"
}
- },
- "id": "GooglePrivacyDlpV2beta2CategoricalStatsConfig"
+ }
},
"GooglePrivacyDlpV2beta1LDiversityConfig": {
"description": "l-diversity metric, used for analysis of reidentification risk.",
@@ -1970,22 +2390,23 @@
"id": "GooglePrivacyDlpV2beta1LDiversityConfig"
},
"GooglePrivacyDlpV2beta2ValueFrequency": {
+ "id": "GooglePrivacyDlpV2beta2ValueFrequency",
+ "description": "A value of a field, including its frequency.",
+ "type": "object",
"properties": {
"value": {
- "description": "A value contained in the field in question.",
- "$ref": "GooglePrivacyDlpV2beta2Value"
+ "$ref": "GooglePrivacyDlpV2beta2Value",
+ "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": "GooglePrivacyDlpV2beta2ValueFrequency",
- "description": "A value of a field, including its frequency.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta2ReplaceValueConfig": {
+ "id": "GooglePrivacyDlpV2beta2ReplaceValueConfig",
"description": "Replace each input value with a given `Value`.",
"type": "object",
"properties": {
@@ -1993,13 +2414,17 @@
"description": "Value to replace it with.",
"$ref": "GooglePrivacyDlpV2beta2Value"
}
- },
- "id": "GooglePrivacyDlpV2beta2ReplaceValueConfig"
+ }
},
"GooglePrivacyDlpV2beta2AuxiliaryTable": {
+ "id": "GooglePrivacyDlpV2beta2AuxiliaryTable",
"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": {
+ "table": {
+ "description": "Auxiliary table location. [required]",
+ "$ref": "GooglePrivacyDlpV2beta2BigQueryTable"
+ },
"quasiIds": {
"description": "Quasi-identifier columns. [required]",
"type": "array",
@@ -2008,15 +2433,10 @@
}
},
"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"
- },
- "table": {
- "description": "Auxiliary table location. [required]",
- "$ref": "GooglePrivacyDlpV2beta2BigQueryTable"
+ "$ref": "GooglePrivacyDlpV2beta2FieldId",
+ "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": "GooglePrivacyDlpV2beta2AuxiliaryTable"
+ }
},
"GooglePrivacyDlpV2beta1StorageConfig": {
"description": "Shared message indicating Cloud storage type.",
@@ -2031,13 +2451,16 @@
"description": "Google Cloud Datastore options specification."
},
"bigQueryOptions": {
- "description": "BigQuery options specification.",
- "$ref": "GooglePrivacyDlpV2beta1BigQueryOptions"
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryOptions",
+ "description": "BigQuery options specification."
}
},
"id": "GooglePrivacyDlpV2beta1StorageConfig"
},
"GooglePrivacyDlpV2beta1BigQueryOptions": {
+ "id": "GooglePrivacyDlpV2beta1BigQueryOptions",
+ "description": "Options defining BigQuery table and row identifiers.",
+ "type": "object",
"properties": {
"tableReference": {
"$ref": "GooglePrivacyDlpV2beta1BigQueryTable",
@@ -2050,10 +2473,7 @@
"$ref": "GooglePrivacyDlpV2beta1FieldId"
}
}
- },
- "id": "GooglePrivacyDlpV2beta1BigQueryOptions",
- "description": "Options defining BigQuery table and row identifiers.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta1PrivacyMetric": {
"description": "Privacy metric to compute for reidentification risk analysis.",
@@ -2078,9 +2498,14 @@
"id": "GooglePrivacyDlpV2beta1PrivacyMetric"
},
"GooglePrivacyDlpV2beta2Location": {
+ "id": "GooglePrivacyDlpV2beta2Location",
"description": "Specifies the location of a finding within its source item.",
"type": "object",
"properties": {
+ "recordKey": {
+ "description": "Key of the finding.",
+ "$ref": "GooglePrivacyDlpV2beta2RecordKey"
+ },
"tableLocation": {
"description": "Location within a `ContentItem.Table`.",
"$ref": "GooglePrivacyDlpV2beta2TableLocation"
@@ -2090,8 +2515,8 @@
"$ref": "GooglePrivacyDlpV2beta2Range"
},
"fieldId": {
- "description": "Field id of the field containing the finding.",
- "$ref": "GooglePrivacyDlpV2beta2FieldId"
+ "$ref": "GooglePrivacyDlpV2beta2FieldId",
+ "description": "Field id of the field containing the finding."
},
"imageBoxes": {
"description": "Location within an image's pixels.",
@@ -2103,44 +2528,45 @@
"byteRange": {
"$ref": "GooglePrivacyDlpV2beta2Range",
"description": "Zero-based byte offsets within a content item."
- },
- "recordKey": {
- "description": "Key of the finding.",
- "$ref": "GooglePrivacyDlpV2beta2RecordKey"
}
- },
- "id": "GooglePrivacyDlpV2beta2Location"
+ }
},
"GooglePrivacyDlpV2beta2ReidentifyContentResponse": {
+ "id": "GooglePrivacyDlpV2beta2ReidentifyContentResponse",
"description": "Results of re-identifying a item.",
"type": "object",
"properties": {
"overview": {
- "$ref": "GooglePrivacyDlpV2beta2TransformationOverview",
- "description": "An overview of the changes that were made to the `item`."
+ "description": "An overview of the changes that were made to the `item`.",
+ "$ref": "GooglePrivacyDlpV2beta2TransformationOverview"
},
"item": {
- "description": "The re-identified item.",
- "$ref": "GooglePrivacyDlpV2beta2ContentItem"
+ "$ref": "GooglePrivacyDlpV2beta2ContentItem",
+ "description": "The re-identified item."
}
- },
- "id": "GooglePrivacyDlpV2beta2ReidentifyContentResponse"
+ }
},
"GooglePrivacyDlpV2beta2TransientCryptoKey": {
+ "description": "Use this to have a random data crypto key generated.\nIt will be discarded after the request finishes.",
+ "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).",
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2TransientCryptoKey",
- "description": "Use this to have a random data crypto key generated.\nIt will be discarded after the request finishes.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2TransientCryptoKey"
},
"GooglePrivacyDlpV2beta1LDiversityEquivalenceClass": {
+ "id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass",
"description": "The set of columns' values that share the same l-diversity value.",
"type": "object",
"properties": {
+ "equivalenceClassSize": {
+ "description": "Size of the k-anonymity equivalence class.",
+ "format": "int64",
+ "type": "string"
+ },
"quasiIdsValues": {
"description": "Quasi-identifier values defining the k-anonymity equivalence\nclass. The order is always the same as the original request.",
"type": "array",
@@ -2159,31 +2585,27 @@
"items": {
"$ref": "GooglePrivacyDlpV2beta1ValueFrequency"
}
- },
- "equivalenceClassSize": {
- "description": "Size of the k-anonymity equivalence class.",
- "format": "int64",
- "type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass"
+ }
},
"GooglePrivacyDlpV2beta1NumericalStatsConfig": {
+ "description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.",
+ "type": "object",
"properties": {
"field": {
- "$ref": "GooglePrivacyDlpV2beta1FieldId",
- "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": "GooglePrivacyDlpV2beta1FieldId"
}
},
- "id": "GooglePrivacyDlpV2beta1NumericalStatsConfig",
- "description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.",
- "type": "object"
+ "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 info type. [required]"
+ "description": "Primitive transformation to apply to the info type. [required]",
+ "$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation"
},
"infoTypes": {
"description": "Info types to apply the transformation to. Empty list will match all\navailable info types for this transformation.",
@@ -2193,23 +2615,28 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta2InfoTypeTransformation",
- "description": "A transformation to apply to text that is identified as a specific\ninfo_type.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta2CloudStorageOptions": {
- "properties": {
- "fileSet": {
- "$ref": "GooglePrivacyDlpV2beta2FileSet"
- }
- },
- "id": "GooglePrivacyDlpV2beta2CloudStorageOptions",
- "description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2InfoTypeTransformation"
},
"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.",
+ "type": "object",
"properties": {
+ "field": {
+ "$ref": "GooglePrivacyDlpV2beta2FieldId",
+ "description": "Field within the record this condition is evaluated against. [required]"
+ },
"operator": {
+ "enumDescriptions": [
+ "",
+ "Equal.",
+ "Not equal to.",
+ "Greater than.",
+ "Less than.",
+ "Greater than or equals.",
+ "Less than or equals.",
+ "Exists"
+ ],
"enum": [
"RELATIONAL_OPERATOR_UNSPECIFIED",
"EQUAL_TO",
@@ -2221,30 +2648,23 @@
"EXISTS"
],
"description": "Operator used to compare the field or info type to the value. [required]",
- "type": "string",
- "enumDescriptions": [
- "",
- "Equal.",
- "Not equal to.",
- "Greater than.",
- "Less than.",
- "Greater than or equals.",
- "Less than or equals.",
- "Exists"
- ]
+ "type": "string"
},
"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]"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2CloudStorageOptions": {
+ "description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket.",
+ "type": "object",
+ "properties": {
+ "fileSet": {
+ "$ref": "GooglePrivacyDlpV2beta2FileSet"
}
},
- "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.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2CloudStorageOptions"
},
"GooglePrivacyDlpV2beta2TableLocation": {
"description": "Location of a finding within a `ContentItem.Table`.",
@@ -2259,6 +2679,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.",
@@ -2268,14 +2690,21 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta2KMapEstimationResult",
- "description": "Result of the reidentifiability analysis. Note that these results are an\nestimation, not exact values.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2KMapEstimationResult"
},
"GooglePrivacyDlpV2beta2PrimitiveTransformation": {
"description": "A rule for transforming a value.",
"type": "object",
"properties": {
+ "redactConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2RedactConfig"
+ },
+ "bucketingConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2BucketingConfig"
+ },
+ "replaceWithInfoTypeConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig"
+ },
"cryptoHashConfig": {
"$ref": "GooglePrivacyDlpV2beta2CryptoHashConfig"
},
@@ -2285,23 +2714,14 @@
"replaceConfig": {
"$ref": "GooglePrivacyDlpV2beta2ReplaceValueConfig"
},
- "fixedSizeBucketingConfig": {
- "$ref": "GooglePrivacyDlpV2beta2FixedSizeBucketingConfig"
- },
"timePartConfig": {
"$ref": "GooglePrivacyDlpV2beta2TimePartConfig"
},
+ "fixedSizeBucketingConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2FixedSizeBucketingConfig"
+ },
"characterMaskConfig": {
"$ref": "GooglePrivacyDlpV2beta2CharacterMaskConfig"
- },
- "bucketingConfig": {
- "$ref": "GooglePrivacyDlpV2beta2BucketingConfig"
- },
- "redactConfig": {
- "$ref": "GooglePrivacyDlpV2beta2RedactConfig"
- },
- "replaceWithInfoTypeConfig": {
- "$ref": "GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig"
}
},
"id": "GooglePrivacyDlpV2beta2PrimitiveTransformation"
@@ -2326,12 +2746,13 @@
"id": "GooglePrivacyDlpV2beta2KAnonymityEquivalenceClass"
},
"GooglePrivacyDlpV2beta1NumericalStatsResult": {
+ "id": "GooglePrivacyDlpV2beta1NumericalStatsResult",
"description": "Result of the numerical stats computation.",
"type": "object",
"properties": {
"maxValue": {
- "$ref": "GooglePrivacyDlpV2beta1Value",
- "description": "Maximum value appearing in the column."
+ "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.",
@@ -2344,39 +2765,39 @@
"description": "Minimum value appearing in the column.",
"$ref": "GooglePrivacyDlpV2beta1Value"
}
- },
- "id": "GooglePrivacyDlpV2beta1NumericalStatsResult"
+ }
},
"GooglePrivacyDlpV2beta2InfoType": {
+ "id": "GooglePrivacyDlpV2beta2InfoType",
+ "description": "Type of information detected by the API.",
+ "type": "object",
"properties": {
"name": {
"description": "Name of the information type.",
"type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta2InfoType",
- "description": "Type of information detected by the API.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta2ListDlpJobsResponse": {
+ "id": "GooglePrivacyDlpV2beta2ListDlpJobsResponse",
+ "description": "The response message for listing DLP jobs.",
+ "type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
"jobs": {
"description": "A list of DlpJobs that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta2DlpJob"
}
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta2ListDlpJobsResponse",
- "description": "The response message for listing DLP jobs.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta1Dictionary": {
+ "id": "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.",
"type": "object",
"properties": {
@@ -2384,20 +2805,19 @@
"description": "List of words or phrases to search for.",
"$ref": "GooglePrivacyDlpV2beta1WordList"
}
- },
- "id": "GooglePrivacyDlpV2beta1Dictionary"
+ }
},
"GooglePrivacyDlpV2beta1DatastoreOptions": {
"description": "Options defining a data set within Google Cloud Datastore.",
"type": "object",
"properties": {
"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."
+ "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": {
- "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.",
@@ -2410,40 +2830,23 @@
"id": "GooglePrivacyDlpV2beta1DatastoreOptions"
},
"GooglePrivacyDlpV2beta2RiskAnalysisJobConfig": {
+ "id": "GooglePrivacyDlpV2beta2RiskAnalysisJobConfig",
"description": "Configuration for a risk analysis job.",
"type": "object",
"properties": {
+ "sourceTable": {
+ "description": "Input dataset to compute metrics over.",
+ "$ref": "GooglePrivacyDlpV2beta2BigQueryTable"
+ },
"privacyMetric": {
"description": "Privacy metric to compute.",
"$ref": "GooglePrivacyDlpV2beta2PrivacyMetric"
- },
- "sourceTable": {
- "$ref": "GooglePrivacyDlpV2beta2BigQueryTable",
- "description": "Input dataset to compute metrics over."
}
- },
- "id": "GooglePrivacyDlpV2beta2RiskAnalysisJobConfig"
- },
- "GooglePrivacyDlpV2beta2StorageConfig": {
- "properties": {
- "cloudStorageOptions": {
- "description": "Google Cloud Storage options specification.",
- "$ref": "GooglePrivacyDlpV2beta2CloudStorageOptions"
- },
- "datastoreOptions": {
- "description": "Google Cloud Datastore options specification.",
- "$ref": "GooglePrivacyDlpV2beta2DatastoreOptions"
- },
- "bigQueryOptions": {
- "$ref": "GooglePrivacyDlpV2beta2BigQueryOptions",
- "description": "BigQuery options specification."
- }
- },
- "id": "GooglePrivacyDlpV2beta2StorageConfig",
- "description": "Shared message indicating Cloud storage type.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta2UnwrappedCryptoKey": {
+ "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]",
@@ -2451,11 +2854,30 @@
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta2UnwrappedCryptoKey",
- "description": "Using raw keys is prone to security risks due to accidentally\nleaking the key. Choose another type of key if possible.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2UnwrappedCryptoKey"
+ },
+ "GooglePrivacyDlpV2beta2StorageConfig": {
+ "id": "GooglePrivacyDlpV2beta2StorageConfig",
+ "description": "Shared message indicating Cloud storage type.",
+ "type": "object",
+ "properties": {
+ "cloudStorageOptions": {
+ "description": "Google Cloud Storage options specification.",
+ "$ref": "GooglePrivacyDlpV2beta2CloudStorageOptions"
+ },
+ "datastoreOptions": {
+ "$ref": "GooglePrivacyDlpV2beta2DatastoreOptions",
+ "description": "Google Cloud Datastore options specification."
+ },
+ "bigQueryOptions": {
+ "description": "BigQuery options specification.",
+ "$ref": "GooglePrivacyDlpV2beta2BigQueryOptions"
+ }
+ }
},
"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 info type. Cannot specify more than one\nfor a given info type. [required]",
@@ -2465,20 +2887,12 @@
}
}
},
- "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": {
+ "id": "GooglePrivacyDlpV2beta2KAnonymityHistogramBucket",
"type": "object",
"properties": {
- "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": "GooglePrivacyDlpV2beta2KAnonymityEquivalenceClass"
- }
- },
"equivalenceClassSizeLowerBound": {
"description": "Lower bound on the size of the equivalence classes in this bucket.",
"format": "int64",
@@ -2493,12 +2907,41 @@
"description": "Total number of equivalence classes 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": "GooglePrivacyDlpV2beta2KAnonymityEquivalenceClass"
+ }
}
- },
- "id": "GooglePrivacyDlpV2beta2KAnonymityHistogramBucket"
+ }
},
"GooglePrivacyDlpV2beta1InspectConfig": {
+ "id": "GooglePrivacyDlpV2beta1InspectConfig",
+ "description": "Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.",
+ "type": "object",
"properties": {
+ "minLikelihood": {
+ "description": "Only returns findings equal or above this threshold.",
+ "type": "string",
+ "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"
+ ]
+ },
"infoTypeLimits": {
"description": "Configuration of findings limit given for specified info types.",
"type": "array",
@@ -2532,43 +2975,32 @@
"excludeTypes": {
"description": "When true, excludes type information of the findings.",
"type": "boolean"
- },
- "minLikelihood": {
- "enum": [
- "LIKELIHOOD_UNSPECIFIED",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Only returns findings equal or above this threshold.",
- "type": "string",
- "enumDescriptions": [
- "Default value; information with all likelihoods is included.",
- "Few matching elements.",
- "",
- "Some matching elements.",
- "",
- "Many matching elements."
- ]
}
- },
- "id": "GooglePrivacyDlpV2beta1InspectConfig",
- "description": "Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.",
- "type": "object"
+ }
+ },
+ "GooglePrivacyDlpV2beta1Projection": {
+ "id": "GooglePrivacyDlpV2beta1Projection",
+ "description": "A representation of a Datastore property in a projection.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "description": "The property to project.",
+ "$ref": "GooglePrivacyDlpV2beta1PropertyReference"
+ }
+ }
},
"GooglePrivacyDlpV2beta2Value": {
+ "id": "GooglePrivacyDlpV2beta2Value",
"description": "Set of primitive values supported by the system.",
"type": "object",
"properties": {
- "timeValue": {
- "$ref": "GoogleTypeTimeOfDay"
- },
"integerValue": {
"format": "int64",
"type": "string"
},
+ "timeValue": {
+ "$ref": "GoogleTypeTimeOfDay"
+ },
"stringValue": {
"type": "string"
},
@@ -2586,21 +3018,23 @@
"format": "double",
"type": "number"
}
- },
- "id": "GooglePrivacyDlpV2beta2Value"
+ }
},
- "GooglePrivacyDlpV2beta1Projection": {
- "description": "A representation of a Datastore property in a projection.",
+ "GooglePrivacyDlpV2beta2RequestedOptions": {
"type": "object",
"properties": {
- "property": {
- "$ref": "GooglePrivacyDlpV2beta1PropertyReference",
- "description": "The property to project."
+ "snapshotInspectTemplate": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectTemplate",
+ "description": "If run with an inspect template, a snapshot of it's state at the time of\nthis run."
+ },
+ "jobConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectJobConfig"
}
},
- "id": "GooglePrivacyDlpV2beta1Projection"
+ "id": "GooglePrivacyDlpV2beta2RequestedOptions"
},
"GooglePrivacyDlpV2beta2ImageRedactionConfig": {
+ "id": "GooglePrivacyDlpV2beta2ImageRedactionConfig",
"description": "Configuration for determining how redaction of images should occur.",
"type": "object",
"properties": {
@@ -2613,34 +3047,16 @@
"type": "boolean"
},
"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"
}
- },
- "id": "GooglePrivacyDlpV2beta2ImageRedactionConfig"
- },
- "GooglePrivacyDlpV2beta2RequestedOptions": {
- "properties": {
- "snapshotInspectTemplate": {
- "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"
+ }
},
"GoogleTypeDate": {
+ "id": "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`.",
"type": "object",
"properties": {
- "month": {
- "description": "Month of year. Must be from 1 to 12.",
- "format": "int32",
- "type": "integer"
- },
"year": {
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"format": "int32",
@@ -2650,9 +3066,13 @@
"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": "GoogleTypeDate"
+ }
},
"GooglePrivacyDlpV2beta2ListInfoTypesResponse": {
"description": "Response to the ListInfoTypes request.",
@@ -2669,86 +3089,78 @@
"id": "GooglePrivacyDlpV2beta2ListInfoTypesResponse"
},
"GooglePrivacyDlpV2beta2FileSet": {
+ "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": "GooglePrivacyDlpV2beta2FileSet",
- "description": "Set of files to scan.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2FileSet"
},
"GooglePrivacyDlpV2beta1CustomInfoType": {
+ "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",
"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"
+ "$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": {
- "description": "Dictionary-based custom info type.",
- "$ref": "GooglePrivacyDlpV2beta1Dictionary"
+ "$ref": "GooglePrivacyDlpV2beta1Dictionary",
+ "description": "Dictionary-based custom info type."
},
"surrogateType": {
- "$ref": "GooglePrivacyDlpV2beta1SurrogateType",
- "description": "Surrogate info type."
+ "description": "Surrogate info type.",
+ "$ref": "GooglePrivacyDlpV2beta1SurrogateType"
}
- },
- "id": "GooglePrivacyDlpV2beta1CustomInfoType"
+ }
},
"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"
},
"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).",
"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"
- },
"quasiIds": {
"description": "Quasi-identifier columns. [required]",
"type": "array",
"items": {
"$ref": "GooglePrivacyDlpV2beta1QuasiIdField"
}
+ },
+ "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"
+ },
+ "table": {
+ "description": "Auxiliary table location. [required]",
+ "$ref": "GooglePrivacyDlpV2beta1BigQueryTable"
}
- },
- "id": "GooglePrivacyDlpV2beta1AuxiliaryTable"
- },
- "GooglePrivacyDlpV2beta1KMapEstimationResult": {
- "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.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1KMapEstimationResult",
- "description": "Result of the reidentifiability analysis. Note that these results are an\nestimation, not exact values.",
- "type": "object"
+ }
},
"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",
"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"
@@ -2757,22 +3169,31 @@
"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": "GoogleRpcStatus"
+ }
+ },
+ "GooglePrivacyDlpV2beta1KMapEstimationResult": {
+ "id": "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.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket"
+ }
+ }
+ }
},
"GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest": {
+ "id": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest",
"description": "Request message for CreateDeidentifyTemplate.",
"type": "object",
"properties": {
@@ -2784,17 +3205,12 @@
"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"
}
- },
- "id": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest"
+ }
},
"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": {
- "imageType": {
- "description": "Type of the content, as defined in Content-Type HTTP header.\nSupported types are: PNG, JPEG, SVG, & BMP.",
- "type": "string"
- },
"imageRedactionConfigs": {
"description": "The configuration for specifying what content to redact from images.",
"type": "array",
@@ -2803,13 +3219,17 @@
}
},
"inspectConfig": {
- "description": "Configuration for the inspector.",
- "$ref": "GooglePrivacyDlpV2beta2InspectConfig"
+ "$ref": "GooglePrivacyDlpV2beta2InspectConfig",
+ "description": "Configuration for the inspector."
},
"imageData": {
"description": "The bytes of the image to redact.",
"format": "byte",
"type": "string"
+ },
+ "imageType": {
+ "description": "Type of the content, as defined in Content-Type HTTP header.\nSupported types are: PNG, JPEG, SVG, & BMP.",
+ "type": "string"
}
},
"id": "GooglePrivacyDlpV2beta2RedactImageRequest"
@@ -2834,6 +3254,9 @@
"id": "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues"
},
"GooglePrivacyDlpV2beta2WordList": {
+ "id": "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]",
@@ -2842,12 +3265,12 @@
"type": "string"
}
}
- },
- "id": "GooglePrivacyDlpV2beta2WordList",
- "description": "Message defining a list of words or phrases to search for in the data.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta2ContentItem": {
+ "id": "GooglePrivacyDlpV2beta2ContentItem",
+ "description": "Container structure for the content to inspect.",
+ "type": "object",
"properties": {
"value": {
"description": "String data to inspect or redact.",
@@ -2866,12 +3289,12 @@
"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": "GooglePrivacyDlpV2beta2ContentItem",
- "description": "Container structure for the content to inspect.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta2CategoricalStatsResult": {
+ "id": "GooglePrivacyDlpV2beta2CategoricalStatsResult",
+ "description": "Result of the categorical stats computation.",
+ "type": "object",
"properties": {
"valueFrequencyHistogramBuckets": {
"description": "Histogram of value frequencies in the column.",
@@ -2880,10 +3303,7 @@
"$ref": "GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket"
}
}
- },
- "id": "GooglePrivacyDlpV2beta2CategoricalStatsResult",
- "description": "Result of the categorical stats computation.",
- "type": "object"
+ }
},
"GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig": {
"description": "Replace each matching finding with the name of the info_type.",
@@ -2892,6 +3312,9 @@
"id": "GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig"
},
"GooglePrivacyDlpV2beta2Key": {
+ "id": "GooglePrivacyDlpV2beta2Key",
+ "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": {
"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.",
@@ -2901,15 +3324,14 @@
}
},
"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."
+ "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",
- "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"
+ }
},
"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": {
"tableId": {
"description": "Name of the table.",
@@ -2924,15 +3346,16 @@
"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": {
+ "id": "GooglePrivacyDlpV2beta2FieldTransformation",
+ "description": "The transformation to apply to the field.",
+ "type": "object",
"properties": {
"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."
+ "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",
@@ -2949,10 +3372,7 @@
"description": "Apply the transformation to the entire field.",
"$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation"
}
- },
- "id": "GooglePrivacyDlpV2beta2FieldTransformation",
- "description": "The transformation to apply to the field.",
- "type": "object"
+ }
},
"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.",
@@ -2974,26 +3394,26 @@
},
"id": "GooglePrivacyDlpV2beta2PathElement"
},
+ "GooglePrivacyDlpV2beta2RecordSuppression": {
+ "description": "Configuration to suppress records whose suppression conditions evaluate to\ntrue.",
+ "type": "object",
+ "properties": {
+ "condition": {
+ "$ref": "GooglePrivacyDlpV2beta2RecordCondition"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2RecordSuppression"
+ },
"GooglePrivacyDlpV2beta1KindExpression": {
+ "description": "A representation of a Datastore kind.",
+ "type": "object",
"properties": {
"name": {
"description": "The name of the kind.",
"type": "string"
}
},
- "id": "GooglePrivacyDlpV2beta1KindExpression",
- "description": "A representation of a Datastore kind.",
- "type": "object"
- },
- "GooglePrivacyDlpV2beta2RecordSuppression": {
- "properties": {
- "condition": {
- "$ref": "GooglePrivacyDlpV2beta2RecordCondition"
- }
- },
- "id": "GooglePrivacyDlpV2beta2RecordSuppression",
- "description": "Configuration to suppress records whose suppression conditions evaluate to\ntrue.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1KindExpression"
},
"GooglePrivacyDlpV2beta2NumericalStatsConfig": {
"description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.",
@@ -3007,6 +3427,7 @@
"id": "GooglePrivacyDlpV2beta2NumericalStatsConfig"
},
"GooglePrivacyDlpV2beta2OutputStorageConfig": {
+ "id": "GooglePrivacyDlpV2beta2OutputStorageConfig",
"description": "Cloud repository for storing output.",
"type": "object",
"properties": {
@@ -3014,27 +3435,15 @@
"$ref": "GooglePrivacyDlpV2beta2BigQueryTable",
"description": "Store findings in a new table in an existing dataset."
}
- },
- "id": "GooglePrivacyDlpV2beta2OutputStorageConfig"
- },
- "GooglePrivacyDlpV2beta1FileSet": {
- "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"
+ }
},
"GooglePrivacyDlpV2beta2InfoTypeLimit": {
"description": "Max findings configuration per info type, 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"
+ "$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."
},
"maxFindings": {
"description": "Max findings limit for the given infoType.",
@@ -3044,7 +3453,19 @@
},
"id": "GooglePrivacyDlpV2beta2InfoTypeLimit"
},
+ "GooglePrivacyDlpV2beta1FileSet": {
+ "id": "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"
+ }
+ }
+ },
"GooglePrivacyDlpV2beta2InfoTypeStatistics": {
+ "id": "GooglePrivacyDlpV2beta2InfoTypeStatistics",
"description": "Statistics regarding a specific InfoType.",
"type": "object",
"properties": {
@@ -3057,10 +3478,11 @@
"$ref": "GooglePrivacyDlpV2beta2InfoType",
"description": "The type of finding this stat is for."
}
- },
- "id": "GooglePrivacyDlpV2beta2InfoTypeStatistics"
+ }
},
"GooglePrivacyDlpV2beta2LDiversityConfig": {
+ "description": "l-diversity metric, used for analysis of reidentification risk.",
+ "type": "object",
"properties": {
"sensitiveAttribute": {
"description": "Sensitive field for computing the l-value.",
@@ -3074,9 +3496,40 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta2LDiversityConfig",
- "description": "l-diversity metric, used for analysis of reidentification risk.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2LDiversityConfig"
+ },
+ "GooglePrivacyDlpV2beta1KAnonymityResult": {
+ "id": "GooglePrivacyDlpV2beta1KAnonymityResult",
+ "description": "Result of the k-anonymity computation.",
+ "type": "object",
+ "properties": {
+ "equivalenceClassHistogramBuckets": {
+ "description": "Histogram of k-anonymity equivalence classes.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket"
+ }
+ }
+ }
+ },
+ "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"
},
"GooglePrivacyDlpV2beta2RecordTransformations": {
"description": "A type of transformation that is applied over structured data such as a\ntable.",
@@ -3099,40 +3552,8 @@
},
"id": "GooglePrivacyDlpV2beta2RecordTransformations"
},
- "GooglePrivacyDlpV2beta2Table": {
- "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"
- },
- "GooglePrivacyDlpV2beta1KAnonymityResult": {
- "properties": {
- "equivalenceClassHistogramBuckets": {
- "description": "Histogram of k-anonymity equivalence classes.",
- "type": "array",
- "items": {
- "$ref": "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket"
- }
- }
- },
- "id": "GooglePrivacyDlpV2beta1KAnonymityResult",
- "description": "Result of the k-anonymity computation.",
- "type": "object"
- },
"GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket": {
+ "id": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket",
"description": "Histogram bucket of value frequencies in the column.",
"type": "object",
"properties": {
@@ -3158,8 +3579,7 @@
"format": "int64",
"type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket"
+ }
},
"GooglePrivacyDlpV2beta2SummaryResult": {
"description": "A collection that informs the user the number of times a particular\n`TransformationResultCode` and error details occurred.",
@@ -3174,22 +3594,24 @@
"type": "string"
},
"code": {
- "enum": [
- "TRANSFORMATION_RESULT_CODE_UNSPECIFIED",
- "SUCCESS",
- "ERROR"
- ],
"type": "string",
"enumDescriptions": [
"",
"",
""
+ ],
+ "enum": [
+ "TRANSFORMATION_RESULT_CODE_UNSPECIFIED",
+ "SUCCESS",
+ "ERROR"
]
}
},
"id": "GooglePrivacyDlpV2beta2SummaryResult"
},
"GooglePrivacyDlpV2beta1KAnonymityConfig": {
+ "description": "k-anonymity metric, used for analysis of reidentification risk.",
+ "type": "object",
"properties": {
"entityId": {
"$ref": "GooglePrivacyDlpV2beta1EntityId",
@@ -3203,11 +3625,12 @@
}
}
},
- "id": "GooglePrivacyDlpV2beta1KAnonymityConfig",
- "description": "k-anonymity metric, used for analysis of reidentification risk.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta1KAnonymityConfig"
},
"GooglePrivacyDlpV2beta2Range": {
+ "id": "GooglePrivacyDlpV2beta2Range",
+ "description": "Generic half-open interval [start, end)",
+ "type": "object",
"properties": {
"start": {
"description": "Index of the first character of the range (inclusive).",
@@ -3219,27 +3642,26 @@
"format": "int64",
"type": "string"
}
- },
- "id": "GooglePrivacyDlpV2beta2Range",
- "description": "Generic half-open interval [start, end)",
- "type": "object"
+ }
},
"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"
+ "$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."
},
"infoTypeTransformations": {
"description": "Treat the dataset as free-form text and apply the same free text\ntransformation everywhere.",
"$ref": "GooglePrivacyDlpV2beta2InfoTypeTransformations"
}
},
- "id": "GooglePrivacyDlpV2beta2DeidentifyConfig",
- "description": "The configuration that controls how the data will change.",
- "type": "object"
+ "id": "GooglePrivacyDlpV2beta2DeidentifyConfig"
},
"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",
"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.",
@@ -3260,11 +3682,11 @@
"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"
+ "id": "GooglePrivacyDlpV2beta2KMapEstimationConfig"
},
"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",
"properties": {
"buckets": {
"type": "array",
@@ -3273,1056 +3695,634 @@
}
}
},
- "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"
+ "id": "GooglePrivacyDlpV2beta2BucketingConfig"
+ },
+ "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": {
+ "id": "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"
+ }
+ }
+ },
+ "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",
+ "properties": {
+ "customTag": {
+ "type": "string"
+ },
+ "field": {
+ "$ref": "GooglePrivacyDlpV2beta1FieldId"
+ }
+ }
+ },
+ "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": {
+ "cryptoKeyName": {
+ "description": "The resource name of the KMS CryptoKey to use for unwrapping. [required]",
+ "type": "string"
+ },
+ "wrappedKey": {
+ "description": "The wrapped data crypto key. [required]",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "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": {
+ "totalEstimatedBytes": {
+ "description": "Estimate of the number of bytes to process.",
+ "format": "int64",
+ "type": "string"
+ },
+ "infoTypeStats": {
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2InfoTypeStatistics"
+ }
+ },
+ "processedBytes": {
+ "description": "Total size in bytes that were processed.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2Result"
+ },
+ "GooglePrivacyDlpV2beta2CustomInfoType": {
+ "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",
+ "properties": {
+ "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"
+ },
+ "surrogateType": {
+ "$ref": "GooglePrivacyDlpV2beta2SurrogateType",
+ "description": "Surrogate info type."
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2DeidentifyContentResponse": {
+ "id": "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."
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1ValueFrequency": {
+ "description": "A value of a field, including its frequency.",
+ "type": "object",
+ "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"
+ },
+ "GooglePrivacyDlpV2beta1SurrogateType": {
+ "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`.",
+ "type": "object",
+ "properties": {}
+ },
+ "GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig": {
+ "id": "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": {
+ "$ref": "GooglePrivacyDlpV2beta2CryptoKey",
+ "description": "The key used by the encryption algorithm. [required]"
+ },
+ "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": {
+ "description": "The custom info type to annotate the surrogate with.\nThis annotation will be applied to the surrogate by prefixing it with\nthe name of the custom info type 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 info type 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 info type\n[`SurrogateType`](/dlp/docs/reference/rest/v2beta1/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 info type 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 info type 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",
+ "$ref": "GooglePrivacyDlpV2beta2InfoType"
+ },
+ "commonAlphabet": {
+ "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)"
+ ],
+ "enum": [
+ "FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED",
+ "NUMERIC",
+ "HEXADECIMAL",
+ "UPPER_CASE_ALPHA_NUMERIC",
+ "ALPHA_NUMERIC"
+ ]
+ },
+ "radix": {
+ "description": "The native way to select the alphabet. Must be in the range [2, 62].",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "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": {
+ "id": "GooglePrivacyDlpV2beta2FindingLimits",
+ "type": "object",
+ "properties": {
+ "maxFindingsPerInfoType": {
+ "description": "Configuration of findings limit given for specified info types.",
+ "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"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2DlpJob": {
+ "id": "GooglePrivacyDlpV2beta2DlpJob",
+ "description": "Combines all of the information about a DLP job.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "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"
+ ],
+ "type": "string"
+ },
+ "riskDetails": {
+ "$ref": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails",
+ "description": "Results from analyzing risk of a data source."
+ },
+ "name": {
+ "description": "The server-assigned name.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of job.",
+ "type": "string",
+ "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"
+ ]
+ },
+ "endTime": {
+ "description": "Time when the job finished.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1LDiversityHistogramBucket": {
+ "id": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket",
+ "description": "Histogram bucket of sensitive value frequencies in the table.",
+ "type": "object",
+ "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"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2Dictionary": {
+ "id": "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": {
+ "description": "List of words or phrases to search for.",
+ "$ref": "GooglePrivacyDlpV2beta2WordList"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta1Value": {
+ "id": "GooglePrivacyDlpV2beta1Value",
+ "description": "Set of primitive values supported by the system.",
+ "type": "object",
+ "properties": {
+ "stringValue": {
+ "type": "string"
+ },
+ "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"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2RecordCondition": {
+ "id": "GooglePrivacyDlpV2beta2RecordCondition",
+ "description": "A condition for determining whether a transformation should be applied to\na field.",
+ "type": "object",
+ "properties": {
+ "expressions": {
+ "$ref": "GooglePrivacyDlpV2beta2Expressions"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2LDiversityHistogramBucket": {
+ "id": "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"
+ }
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2KindExpression": {
+ "id": "GooglePrivacyDlpV2beta2KindExpression",
+ "description": "A representation of a Datastore kind.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the kind.",
+ "type": "string"
+ }
+ }
+ },
+ "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": {
+ "id": "GooglePrivacyDlpV2beta2InspectResult",
+ "description": "All the findings for a single scanned item.",
+ "type": "object",
+ "properties": {
+ "findings": {
+ "description": "List of findings for an item.",
+ "type": "array",
+ "items": {
+ "$ref": "GooglePrivacyDlpV2beta2Finding"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2CryptoHashConfig": {
+ "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",
+ "properties": {
+ "cryptoKey": {
+ "$ref": "GooglePrivacyDlpV2beta2CryptoKey",
+ "description": "The key used by the hash function."
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2TimePartConfig": {
+ "description": "For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a\nportion of the value.",
+ "type": "object",
+ "properties": {
+ "partToExtract": {
+ "enumDescriptions": [
+ "",
+ "[000-9999]",
+ "[1-12]",
+ "[1-31]",
+ "[1-7]",
+ "[1-52]",
+ "[0-24]"
+ ],
+ "enum": [
+ "TIME_PART_UNSPECIFIED",
+ "YEAR",
+ "MONTH",
+ "DAY_OF_MONTH",
+ "DAY_OF_WEEK",
+ "WEEK_OF_YEAR",
+ "HOUR_OF_DAY"
+ ],
+ "type": "string"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2TimePartConfig"
+ },
+ "GooglePrivacyDlpV2beta1WordList": {
+ "id": "GooglePrivacyDlpV2beta1WordList",
+ "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]",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "GooglePrivacyDlpV2beta2ImageLocation": {
+ "id": "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"
+ }
+ }
+ },
+ "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": {
+ "updateMask": {
+ "description": "Mask to control which fields get updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "inspectTemplate": {
+ "description": "New InspectTemplate value.",
+ "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest"
+ },
+ "GooglePrivacyDlpV2beta2Expressions": {
+ "description": "A collection of expressions",
+ "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": [
+ "",
+ ""
+ ],
+ "enum": [
+ "LOGICAL_OPERATOR_UNSPECIFIED",
+ "AND"
+ ]
+ },
+ "conditions": {
+ "$ref": "GooglePrivacyDlpV2beta2Conditions"
+ }
+ },
+ "id": "GooglePrivacyDlpV2beta2Expressions"
+ },
+ "GooglePrivacyDlpV2beta2InspectDataSourceRequest": {
+ "id": "GooglePrivacyDlpV2beta2InspectDataSourceRequest",
+ "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.",
+ "type": "object",
+ "properties": {
+ "jobConfig": {
+ "$ref": "GooglePrivacyDlpV2beta2InspectJobConfig"
+ }
+ }
}
},
"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": "DLP",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "rootUrl": "https://dlp.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "dlp",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "DLP API",
- "ownerName": "Google",
- "resources": {
- "infoTypes": {
- "methods": {
- "list": {
- "description": "Returns sensitive information types DLP supports.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2ListInfoTypesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/infoTypes",
- "path": "v2beta2/infoTypes",
- "id": "dlp.infoTypes.list"
- }
- }
- },
- "organizations": {
- "resources": {
- "inspectTemplates": {
- "methods": {
- "create": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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}/inspectTemplates",
- "path": "v2beta2/{+parent}/inspectTemplates",
- "id": "dlp.organizations.inspectTemplates.create",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest"
- },
- "description": "Creates an inspect template for re-using frequently used configuration\nfor inspecting content, images, and storage."
- },
- "delete": {
- "path": "v2beta2/{+name}",
- "id": "dlp.organizations.inspectTemplates.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}"
- },
- "patch": {
- "path": "v2beta2/{+name}",
- "id": "dlp.organizations.inspectTemplates.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": {
- "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"
- }
- },
- "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}"
- },
- "get": {
- "id": "dlp.organizations.inspectTemplates.get",
- "path": "v2beta2/{+name}",
- "description": "Gets an inspect template.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
- },
- "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}"
- },
- "list": {
- "path": "v2beta2/{+parent}/inspectTemplates",
- "id": "dlp.organizations.inspectTemplates.list",
- "description": "Lists inspect templates.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "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"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates"
- }
- }
- },
- "deidentifyTemplates": {
- "methods": {
- "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."
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameters": {
- "name": {
- "description": "Resource name of the organization and inspectTemplate to be deleted, for\nexample `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}",
- "description": "Deletes inspect templates."
- },
- "patch": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "name": {
- "description": "Resource name of organization and inspectTemplate to be updated, for\nexample `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}",
- "path": "v2beta2/{+name}",
- "id": "dlp.organizations.deidentifyTemplates.patch",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest"
- },
- "description": "Updates the inspect template."
- },
- "get": {
- "path": "v2beta2/{+name}",
- "id": "dlp.organizations.deidentifyTemplates.get",
- "description": "Gets an inspect template.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Resource name of the organization and inspectTemplate to be read, for\nexample `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}"
- },
- "list": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "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"
- },
- "pageToken": {
- "description": "Optional page token to continue retrieval. Comes from previous call\nto `ListDeidentifyTemplates`.",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates",
- "path": "v2beta2/{+parent}/deidentifyTemplates",
- "id": "dlp.organizations.deidentifyTemplates.list",
- "description": "Lists inspect templates."
- }
- }
- }
- }
- },
- "projects": {
- "resources": {
- "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": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/dlpJobs/[^/]+$",
- "location": "path",
- "description": "The name of the DlpJob resource to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/dlpJobs/{dlpJobsId}",
- "id": "dlp.projects.dlpJobs.delete",
- "path": "v2beta2/{+name}",
- "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": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "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": {
- "description": "The parent resource name, for example projects/my-project-id.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "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.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DlpJob"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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}",
- "path": "v2beta2/{+name}",
- "id": "dlp.projects.dlpJobs.get"
- }
- }
- },
- "inspectTemplates": {
- "methods": {
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
- },
- "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}/inspectTemplates",
- "id": "dlp.projects.inspectTemplates.create",
- "path": "v2beta2/{+parent}/inspectTemplates",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest"
- },
- "description": "Creates an inspect template for re-using frequently used configuration\nfor inspecting content, images, and storage."
- },
- "delete": {
- "description": "Deletes inspect templates.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameters": {
- "name": {
- "description": "Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
- "id": "dlp.projects.inspectTemplates.delete",
- "path": "v2beta2/{+name}"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
- "id": "dlp.projects.inspectTemplates.patch",
- "path": "v2beta2/{+name}",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest"
- },
- "description": "Updates the inspect template."
- },
- "get": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2InspectTemplate"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/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/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}",
- "path": "v2beta2/{+name}",
- "id": "dlp.projects.inspectTemplates.get",
- "description": "Gets an inspect template."
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse"
- },
- "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 `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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates",
- "id": "dlp.projects.inspectTemplates.list",
- "path": "v2beta2/{+parent}/inspectTemplates",
- "description": "Lists inspect templates."
- }
- }
- },
- "content": {
- "methods": {
- "deidentify": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyContentResponse"
- },
- "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}/content:deidentify",
- "path": "v2beta2/{+parent}/content:deidentify",
- "id": "dlp.projects.content.deidentify",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyContentRequest"
- },
- "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)"
- },
- "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": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2ReidentifyContentResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "The parent resource name.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/content:reidentify",
- "path": "v2beta2/{+parent}/content:reidentify",
- "id": "dlp.projects.content.reidentify",
- "description": "Re-identify content that has been de-identified.",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2ReidentifyContentRequest"
- }
- }
- }
- },
- "dataSource": {
- "methods": {
- "inspect": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DlpJob"
- },
- "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",
- "id": "dlp.projects.dataSource.inspect",
- "path": "v2beta2/{+parent}/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)"
- },
- "analyze": {
- "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",
- "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": {
- "delete": {
- "response": {
- "$ref": "GoogleProtobufEmpty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$",
- "location": "path",
- "description": "Resource name of the organization and inspectTemplate to be deleted, 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.delete",
- "description": "Deletes inspect templates."
- },
- "patch": {
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest"
- },
- "description": "Updates the inspect template.",
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$",
- "location": "path",
- "description": "Resource name of organization and inspectTemplate to be updated, 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.patch"
- },
- "get": {
- "description": "Gets an inspect template.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$",
- "location": "path",
- "description": "Resource name of the organization and inspectTemplate 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}",
- "id": "dlp.projects.deidentifyTemplates.get",
- "path": "v2beta2/{+name}"
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse"
- },
- "parameters": {
- "pageToken": {
- "description": "Optional page token to continue retrieval. Comes from previous call\nto `ListDeidentifyTemplates`.",
- "type": "string",
- "location": "query"
- },
- "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": {
- "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.list",
- "path": "v2beta2/{+parent}/deidentifyTemplates",
- "description": "Lists inspect templates."
- },
- "create": {
- "response": {
- "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate"
- },
- "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 or\norganizations/my-org-id.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates",
- "path": "v2beta2/{+parent}/deidentifyTemplates",
- "id": "dlp.projects.deidentifyTemplates.create",
- "description": "Creates an Deidentify template for re-using frequently used configuration\nfor Deidentifying content, images, and storage.",
- "request": {
- "$ref": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest"
- }
- }
- }
- },
- "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": {
- "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"
- }
- }
- }
- }
- }
- },
- "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"
- },
- "$.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"
- },
- "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": {
- "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"
- }
- },
- "version": "v2beta2",
- "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"
+ }
}
diff --git a/firebasedynamiclinks/v1/firebasedynamiclinks-api.json b/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
index d511e29..ad36a56 100644
--- a/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
+++ b/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
@@ -1,47 +1,34 @@
{
+ "ownerDomain": "google.com",
+ "name": "firebasedynamiclinks",
+ "batchPath": "batch",
+ "title": "Firebase Dynamic Links API",
+ "ownerName": "Google",
"resources": {
"shortLinks": {
"methods": {
"create": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "CreateShortDynamicLinkResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/firebase"
- ],
- "flatPath": "v1/shortLinks",
- "id": "firebasedynamiclinks.shortLinks.create",
- "path": "v1/shortLinks",
+ "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"
},
- "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."
+ "response": {
+ "$ref": "CreateShortDynamicLinkResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "parameters": {},
+ "flatPath": "v1/shortLinks",
+ "path": "v1/shortLinks",
+ "id": "firebasedynamiclinks.shortLinks.create"
}
}
},
"v1": {
"methods": {
- "installAttribution": {
- "response": {
- "$ref": "GetIosPostInstallAttributionResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/firebase"
- ],
- "flatPath": "v1/installAttribution",
- "path": "v1/installAttribution",
- "id": "firebasedynamiclinks.installAttribution",
- "request": {
- "$ref": "GetIosPostInstallAttributionRequest"
- },
- "description": "Get iOS strong/weak-match info for post-install attribution."
- },
"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.",
"response": {
@@ -51,9 +38,6 @@
"dynamicLink"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/firebase"
- ],
"parameters": {
"durationDays": {
"location": "query",
@@ -68,9 +52,30 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/firebase"
+ ],
"flatPath": "v1/{dynamicLink}/linkStats",
"path": "v1/{dynamicLink}/linkStats",
"id": "firebasedynamiclinks.getLinkStats"
+ },
+ "installAttribution": {
+ "description": "Get iOS strong/weak-match info for post-install attribution.",
+ "request": {
+ "$ref": "GetIosPostInstallAttributionRequest"
+ },
+ "response": {
+ "$ref": "GetIosPostInstallAttributionResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "parameters": {},
+ "flatPath": "v1/installAttribution",
+ "path": "v1/installAttribution",
+ "id": "firebasedynamiclinks.installAttribution"
}
}
}
@@ -82,20 +87,20 @@
"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"
+ "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\").",
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
"enumDescriptions": [
@@ -116,6 +121,12 @@
"location": "query"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -123,23 +134,17 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
+ "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",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
@@ -147,10 +152,10 @@
"location": "query"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
- "location": "query"
+ "default": "true"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
@@ -175,243 +180,6 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Suffix": {
- "properties": {
- "option": {
- "enumDescriptions": [
- "The suffix option is not specified, performs as NOT_GUESSABLE .",
- "Short Dynamic Link suffix is a base62 [0-9A-Za-z] encoded string of\na random generated 96 bit random number, which has a length of 17 chars.\nFor example, \"nlAR8U4SlKRZw1cb2\".\nIt prevents other people from guessing and crawling short Dynamic Links\nthat contain personal identifiable information.",
- "Short Dynamic Link suffix is a base62 [0-9A-Za-z] string starting with a\nlength of 4 chars. the length will increase when all the space is\noccupied."
- ],
- "enum": [
- "OPTION_UNSPECIFIED",
- "UNGUESSABLE",
- "SHORT"
- ],
- "description": "Suffix option.",
- "type": "string"
- }
- },
- "id": "Suffix",
- "description": "Short Dynamic Link suffix.",
- "type": "object"
- },
- "GooglePlayAnalytics": {
- "properties": {
- "utmSource": {
- "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"
- },
- "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"
- },
- "utmTerm": {
- "description": "Campaign term; used with paid search to supply the keywords for ads.",
- "type": "string"
- }
- },
- "id": "GooglePlayAnalytics",
- "description": "Parameters for Google Play Campaign Measurements.\n[Learn more](https://developers.google.com/analytics/devguides/collection/android/v4/campaigns#campaign-params)",
- "type": "object"
- },
- "DynamicLinkInfo": {
- "properties": {
- "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": {
- "description": "Information of navigation behavior of a Firebase Dynamic Links.",
- "$ref": "NavigationInfo"
- },
- "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)."
- },
- "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": {
- "description": "iOS related information. See iOS related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).",
- "$ref": "IosInfo"
- },
- "socialMetaTagInfo": {
- "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites.",
- "$ref": "SocialMetaTagInfo"
- }
- },
- "id": "DynamicLinkInfo",
- "description": "Information about a Dynamic Link.",
- "type": "object"
- },
- "DeviceInfo": {
- "properties": {
- "deviceModelName": {
- "description": "Device model name.",
- "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"
- },
- "screenResolutionWidth": {
- "description": "Device display resolution width.",
- "format": "int64",
- "type": "string"
- },
- "screenResolutionHeight": {
- "description": "Device display resolution height.",
- "format": "int64",
- "type": "string"
- },
- "languageCode": {
- "description": "Device language code setting.",
- "type": "string"
- },
- "timezone": {
- "description": "Device timezone setting.",
- "type": "string"
- }
- },
- "id": "DeviceInfo",
- "description": "Signals associated with the device making the request.",
- "type": "object"
- },
- "ITunesConnectAnalytics": {
- "description": "Parameters for iTunes Connect App Analytics.",
- "type": "object",
- "properties": {
- "ct": {
- "description": "Campaign text that developers can optionally add to any link in order to\ntrack sales from a specific marketing campaign.",
- "type": "string"
- },
- "mt": {
- "description": "iTune media types, including music, podcasts, audiobooks and so on.",
- "type": "string"
- },
- "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"
- },
- "GetIosPostInstallAttributionResponse": {
- "properties": {
- "appMinimumVersion": {
- "description": "The minimum version for app, specified by dev through ?imv= parameter.\nReturn to iSDK to allow app to evaluate if current version meets this.",
- "type": "string"
- },
- "deepLink": {
- "description": "The deep-link attributed post-install via one of several techniques\n(fingerprint, copy unique).",
- "type": "string"
- },
- "invitationId": {
- "description": "Invitation ID attributed post-install via one of several techniques\n(fingerprint, copy unique).",
- "type": "string"
- },
- "attributionConfidence": {
- "enum": [
- "UNKNOWN_ATTRIBUTION_CONFIDENCE",
- "WEAK",
- "DEFAULT",
- "UNIQUE"
- ],
- "description": "The confidence of the returned attribution.",
- "type": "string",
- "enumDescriptions": [
- "Unset.",
- "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"
- ]
- },
- "externalBrowserDestinationLink": {
- "description": "User-agent specific custom-scheme URIs for iSDK to open. This will be set\naccording to the user-agent tha the click was originally made in. There is\nno Safari-equivalent custom-scheme open URLs.\nie: googlechrome://www.example.com\nie: firefox://open-url?url=http://www.example.com\nie: opera-http://example.com",
- "type": "string"
- },
- "matchMessage": {
- "description": "Describes why match failed, ie: \"discarded due to low confidence\".\nThis message will be publicly visible.",
- "type": "string"
- },
- "resolvedLink": {
- "description": "The entire FDL, expanded from a short link. It is the same as the\nrequested_link, if it is long. Parameters from this should not be\nused directly (ie: server can default utm_[campaign|medium|source]\nto a value when requested_link lack them, server determine the best\nfallback_link when requested_link specifies \u003e1 fallback links).",
- "type": "string"
- },
- "utmCampaign": {
- "description": "Scion campaign value to be propagated by iSDK to Scion at post-install.",
- "type": "string"
- },
- "fallbackLink": {
- "description": "The link to navigate to update the app if min version is not met.\nThis is either (in order): 1) fallback link (from ?ifl= parameter, if\nspecified by developer) or 2) AppStore URL (from ?isi= parameter, if\nspecified), or 3) the payload link (from required link= parameter).",
- "type": "string"
- },
- "requestedLink": {
- "description": "Entire FDL (short or long) attributed post-install via one of several\ntechniques (fingerprint, copy unique).",
- "type": "string"
- },
- "utmMedium": {
- "description": "Scion medium value to be propagated by iSDK to Scion at post-install.",
- "type": "string"
- },
- "utmSource": {
- "description": "Scion source value to be propagated by iSDK to Scion at post-install.",
- "type": "string"
- },
- "isStrongMatchExecutable": {
- "description": "Instruction for iSDK to attemmpt to perform strong match. For instance,\nif browser does not support/allow cookie or outside of support browsers,\nthis will be false.",
- "type": "boolean"
- }
- },
- "id": "GetIosPostInstallAttributionResponse",
- "description": "Response for iSDK to execute strong match flow for post-install attribution.",
- "type": "object"
- },
- "SocialMetaTagInfo": {
- "properties": {
- "socialDescription": {
- "description": "A short description of the link. Optional.",
- "type": "string"
- },
- "socialTitle": {
- "description": "Title to be displayed. Optional.",
- "type": "string"
- },
- "socialImageLink": {
- "description": "An image url string. Optional.",
- "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"
- },
"DynamicLinkStats": {
"description": "Analytics stats of a Dynamic Link for a given timeframe.",
"type": "object",
@@ -427,39 +195,18 @@
"id": "DynamicLinkStats"
},
"DynamicLinkWarning": {
+ "description": "Dynamic Links warning messages.",
+ "type": "object",
"properties": {
+ "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"
+ },
"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": [
@@ -492,25 +239,50 @@
"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"
+ "id": "DynamicLinkWarning"
},
"AndroidInfo": {
"description": "Android related attributes to the Dynamic Link.",
"type": "object",
"properties": {
+ "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"
@@ -522,10 +294,6 @@
"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": "AndroidInfo"
@@ -577,18 +345,24 @@
"type": "object",
"properties": {
"itunesConnectAnalytics": {
- "$ref": "ITunesConnectAnalytics",
- "description": "iTunes Connect App Analytics."
+ "description": "iTunes Connect App Analytics.",
+ "$ref": "ITunesConnectAnalytics"
},
"googlePlayAnalytics": {
- "description": "Google Play Campaign Measurements.",
- "$ref": "GooglePlayAnalytics"
+ "$ref": "GooglePlayAnalytics",
+ "description": "Google Play Campaign Measurements."
}
},
"id": "AnalyticsInfo"
},
"CreateShortDynamicLinkRequest": {
+ "description": "Request to create a short Dynamic Link.",
+ "type": "object",
"properties": {
+ "dynamicLinkInfo": {
+ "$ref": "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)."
+ },
"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"
@@ -596,15 +370,9 @@
"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",
- "description": "Request to create a short Dynamic Link.",
- "type": "object"
+ "id": "CreateShortDynamicLinkRequest"
},
"DesktopInfo": {
"description": "Desktop related attributes to the Dynamic Link.",
@@ -621,20 +389,7 @@
"description": "Dynamic Link event stat.",
"type": "object",
"properties": {
- "count": {
- "description": "The number of times this event occurred.",
- "format": "int64",
- "type": "string"
- },
"event": {
- "enum": [
- "DYNAMIC_LINK_EVENT_UNSPECIFIED",
- "CLICK",
- "REDIRECT",
- "APP_INSTALL",
- "APP_FIRST_OPEN",
- "APP_RE_OPEN"
- ],
"description": "Link event.",
"type": "string",
"enumDescriptions": [
@@ -644,15 +399,17 @@
"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"
]
},
"platform": {
- "enum": [
- "DYNAMIC_LINK_PLATFORM_UNSPECIFIED",
- "ANDROID",
- "IOS",
- "DESKTOP"
- ],
"description": "Requested platform.",
"type": "string",
"enumDescriptions": [
@@ -660,7 +417,18 @@
"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"
]
+ },
+ "count": {
+ "description": "The number of times this event occurred.",
+ "format": "int64",
+ "type": "string"
}
},
"id": "DynamicLinkEventStat"
@@ -669,19 +437,24 @@
"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": {
- "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"
},
+ "visualStyle": {
+ "description": "Strong match page information. Disambiguates between default UI and\ncustom page to present when strong match succeeds/fails to find cookie.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown style.",
+ "Default style.",
+ "Custom style."
+ ],
+ "enum": [
+ "UNKNOWN_VISUAL_STYLE",
+ "DEFAULT_STYLE",
+ "CUSTOM_STYLE"
+ ]
+ },
"retrievalMethod": {
"enumDescriptions": [
"Unknown method.",
@@ -698,20 +471,6 @@
"description": "App post install attribution retrieval information. Disambiguates\nmechanism (iSDK or developer invoked) to retrieve payload from\nclicked link.",
"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"
- },
"sdkVersion": {
"description": "Google SDK version.",
"type": "string"
@@ -723,19 +482,23 @@
"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"
}
},
"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"
@@ -743,18 +506,260 @@
"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.",
+ "type": "object",
+ "properties": {
+ "option": {
+ "enumDescriptions": [
+ "The suffix option is not specified, performs as NOT_GUESSABLE .",
+ "Short Dynamic Link suffix is a base62 [0-9A-Za-z] encoded string of\na random generated 96 bit random number, which has a length of 17 chars.\nFor example, \"nlAR8U4SlKRZw1cb2\".\nIt prevents other people from guessing and crawling short Dynamic Links\nthat contain personal identifiable information.",
+ "Short Dynamic Link suffix is a base62 [0-9A-Za-z] string starting with a\nlength of 4 chars. the length will increase when all the space is\noccupied."
+ ],
+ "enum": [
+ "OPTION_UNSPECIFIED",
+ "UNGUESSABLE",
+ "SHORT"
+ ],
+ "description": "Suffix option.",
+ "type": "string"
+ }
+ },
+ "id": "Suffix"
+ },
+ "GooglePlayAnalytics": {
+ "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": {
+ "utmMedium": {
+ "description": "Campaign medium; used to identify a medium such as email or cost-per-click.",
+ "type": "string"
+ },
+ "utmTerm": {
+ "description": "Campaign term; used with paid search to supply the keywords for ads.",
+ "type": "string"
+ },
+ "utmSource": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "GooglePlayAnalytics"
+ },
+ "DynamicLinkInfo": {
+ "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": {
+ "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"
+ },
+ "navigationInfo": {
+ "description": "Information of navigation behavior of a Firebase Dynamic Links.",
+ "$ref": "NavigationInfo"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "id": "DynamicLinkInfo"
+ },
+ "DeviceInfo": {
+ "description": "Signals associated with the device making the request.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "screenResolutionWidth": {
+ "description": "Device display resolution width.",
+ "format": "int64",
+ "type": "string"
+ },
+ "screenResolutionHeight": {
+ "description": "Device display resolution height.",
+ "format": "int64",
+ "type": "string"
+ },
+ "languageCode": {
+ "description": "Device language code setting.",
+ "type": "string"
+ },
+ "timezone": {
+ "description": "Device timezone setting.",
+ "type": "string"
+ },
+ "deviceModelName": {
+ "description": "Device model name.",
+ "type": "string"
+ }
+ },
+ "id": "DeviceInfo"
+ },
+ "ITunesConnectAnalytics": {
+ "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"
+ },
+ "mt": {
+ "description": "iTune media types, including music, podcasts, audiobooks and so on.",
+ "type": "string"
+ },
+ "pt": {
+ "description": "Provider token that enables analytics for Dynamic Links from within iTunes\nConnect.",
+ "type": "string"
+ }
+ },
+ "id": "ITunesConnectAnalytics"
+ },
+ "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.",
+ "type": "string"
+ },
+ "isStrongMatchExecutable": {
+ "description": "Instruction for iSDK to attemmpt to perform strong match. For instance,\nif browser does not support/allow cookie or outside of support browsers,\nthis will be false.",
+ "type": "boolean"
+ },
+ "appMinimumVersion": {
+ "description": "The minimum version for app, specified by dev through ?imv= parameter.\nReturn to iSDK to allow app to evaluate if current version meets this.",
+ "type": "string"
+ },
+ "deepLink": {
+ "description": "The deep-link attributed post-install via one of several techniques\n(fingerprint, copy unique).",
+ "type": "string"
+ },
+ "invitationId": {
+ "description": "Invitation ID attributed post-install via one of several techniques\n(fingerprint, copy unique).",
+ "type": "string"
+ },
+ "attributionConfidence": {
+ "enumDescriptions": [
+ "Unset.",
+ "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"
+ ],
+ "description": "The confidence of the returned attribution.",
+ "type": "string"
+ },
+ "externalBrowserDestinationLink": {
+ "description": "User-agent specific custom-scheme URIs for iSDK to open. This will be set\naccording to the user-agent tha the click was originally made in. There is\nno Safari-equivalent custom-scheme open URLs.\nie: googlechrome://www.example.com\nie: firefox://open-url?url=http://www.example.com\nie: opera-http://example.com",
+ "type": "string"
+ },
+ "matchMessage": {
+ "description": "Describes why match failed, ie: \"discarded due to low confidence\".\nThis message will be publicly visible.",
+ "type": "string"
+ },
+ "resolvedLink": {
+ "description": "The entire FDL, expanded from a short link. It is the same as the\nrequested_link, if it is long. Parameters from this should not be\nused directly (ie: server can default utm_[campaign|medium|source]\nto a value when requested_link lack them, server determine the best\nfallback_link when requested_link specifies \u003e1 fallback links).",
+ "type": "string"
+ },
+ "utmCampaign": {
+ "description": "Scion campaign value to be propagated by iSDK to Scion at post-install.",
+ "type": "string"
+ },
+ "fallbackLink": {
+ "description": "The link to navigate to update the app if min version is not met.\nThis is either (in order): 1) fallback link (from ?ifl= parameter, if\nspecified by developer) or 2) AppStore URL (from ?isi= parameter, if\nspecified), or 3) the payload link (from required link= parameter).",
+ "type": "string"
+ },
+ "requestedLink": {
+ "description": "Entire FDL (short or long) attributed post-install via one of several\ntechniques (fingerprint, copy unique).",
+ "type": "string"
+ },
+ "utmMedium": {
+ "description": "Scion medium value to be propagated by iSDK to Scion at post-install.",
+ "type": "string"
+ }
+ },
+ "id": "GetIosPostInstallAttributionResponse"
+ },
+ "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.",
+ "type": "string"
+ },
+ "socialTitle": {
+ "description": "Title to be displayed. Optional.",
+ "type": "string"
+ },
+ "socialImageLink": {
+ "description": "An image url string. Optional.",
+ "type": "string"
+ }
+ },
+ "id": "SocialMetaTagInfo"
}
},
- "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": "Firebase Dynamic Links",
"auth": {
"oauth2": {
@@ -765,10 +770,5 @@
}
}
},
- "rootUrl": "https://firebasedynamiclinks-ipv6.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "firebasedynamiclinks",
- "batchPath": "batch",
- "title": "Firebase Dynamic Links API",
- "ownerName": "Google"
+ "rootUrl": "https://firebasedynamiclinks-ipv6.googleapis.com/"
}
diff --git a/firebaseremoteconfig/v1/firebaseremoteconfig-api.json b/firebaseremoteconfig/v1/firebaseremoteconfig-api.json
index 67c2050..1b1ab18 100644
--- a/firebaseremoteconfig/v1/firebaseremoteconfig-api.json
+++ b/firebaseremoteconfig/v1/firebaseremoteconfig-api.json
@@ -1,32 +1,49 @@
{
- "revision": "20171129",
- "documentationLink": "https://firebase.google.com/docs/remote-config/",
"id": "firebaseremoteconfig:v1",
+ "documentationLink": "https://firebase.google.com/docs/remote-config/",
+ "revision": "20171129",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "RemoteConfigParameterValue": {
+ "properties": {
+ "value": {
+ "description": "the string to set the parameter to",
+ "type": "string"
+ },
+ "useInAppDefault": {
+ "description": "if true, omit the parameter from the map of fetched parameter values",
+ "type": "boolean"
+ }
+ },
+ "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": {
- "conditions": {
- "description": "The list of named conditions. The order *does* affect the semantics.\nThe condition_name values of these entries must be unique.\n\nThe resolved value of a config parameter P is determined as follow:\n* Let Y be the set of values from the submap of P that refer to conditions\n that evaluate to \u003ccode\u003etrue\u003c/code\u003e.\n* If Y is non empty, the value is taken from the specific submap in Y whose\n condition_name is the earliest in this condition list.\n* Else, if P has a default value option (condition_name is empty) then\n the value is taken from that option.\n* Else, parameter P has no value and is omitted from the config result.\n\nExample: parameter key \"p1\", default value \"v1\", submap specified as\n{\"c1\": v2, \"c2\": v3} where \"c1\" and \"c2\" are names of conditions in the\ncondition list (where \"c1\" in this example appears before \"c2\"). The\nvalue of p1 would be v2 as long as c1 is true. Otherwise, if c2 is true,\np1 would evaluate to v3, and if c1 and c2 are both false, p1 would evaluate\nto v1. If no default value was specified, and c1 and c2 were both false,\nno value for p1 would be generated.",
- "type": "array",
- "items": {
- "$ref": "RemoteConfigCondition"
- }
- },
"parameters": {
"additionalProperties": {
"$ref": "RemoteConfigParameter"
},
"description": "Map of parameter keys to their optional default values and optional submap\nof (condition name : value). Order doesn't affect semantics, and so is\nsorted by the server. The 'key' values of the params must be unique.",
"type": "object"
+ },
+ "conditions": {
+ "description": "The list of named conditions. The order *does* affect the semantics.\nThe condition_name values of these entries must be unique.\n\nThe resolved value of a config parameter P is determined as follow:\n* Let Y be the set of values from the submap of P that refer to conditions\n that evaluate to \u003ccode\u003etrue\u003c/code\u003e.\n* If Y is non empty, the value is taken from the specific submap in Y whose\n condition_name is the earliest in this condition list.\n* Else, if P has a default value option (condition_name is empty) then\n the value is taken from that option.\n* Else, parameter P has no value and is omitted from the config result.\n\nExample: parameter key \"p1\", default value \"v1\", submap specified as\n{\"c1\": v2, \"c2\": v3} where \"c1\" and \"c2\" are names of conditions in the\ncondition list (where \"c1\" in this example appears before \"c2\"). The\nvalue of p1 would be v2 as long as c1 is true. Otherwise, if c2 is true,\np1 would evaluate to v3, and if c1 and c2 are both false, p1 would evaluate\nto v1. If no default value was specified, and c1 and c2 were both false,\nno value for p1 would be generated.",
+ "type": "array",
+ "items": {
+ "$ref": "RemoteConfigCondition"
+ }
}
},
"id": "RemoteConfig"
},
"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": {
"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",
@@ -40,13 +57,11 @@
"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."
+ "description": "Optional - value to set the parameter to, when none of the named conditions\nevaluate to \u003ccode\u003etrue\u003c/code\u003e.",
+ "$ref": "RemoteConfigParameterValue"
}
},
- "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"
+ "id": "RemoteConfigParameter"
},
"RemoteConfigCondition": {
"description": "A single RemoteConfig Condition. A list of these (because order matters) are\npart of a single RemoteConfig template.",
@@ -61,24 +76,10 @@
"type": "string"
},
"expression": {
- "type": "string",
- "description": "Required."
+ "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",
@@ -94,25 +95,24 @@
"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"
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "Blue",
+ "Brown",
+ "Cyan",
+ "aka \"Red Orange\"",
+ "Green",
+ "Indigo\n*",
+ "Lime - Approved deviation from Material color palette",
+ "Orange",
+ "Pink",
+ "Purple",
+ "Teal"
+ ]
}
},
"id": "RemoteConfigCondition"
- },
- "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",
- "type": "string"
- },
- "useInAppDefault": {
- "description": "if true, omit the parameter from the map of fetched parameter values",
- "type": "boolean"
- }
- },
- "id": "RemoteConfigParameterValue"
}
},
"icons": {
@@ -132,9 +132,6 @@
"projects": {
"methods": {
"getRemoteConfig": {
- "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"
},
@@ -144,17 +141,19 @@
"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"
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/remoteConfig"
+ "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."
},
"updateRemoteConfig": {
- "flatPath": "v1/projects/{projectsId}/remoteConfig",
"path": "v1/{+project}/remoteConfig",
"id": "firebaseremoteconfig.projects.updateRemoteConfig",
"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.",
@@ -175,13 +174,14 @@
"type": "boolean"
},
"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/[^/]+$"
+ "type": "string"
}
- }
+ },
+ "flatPath": "v1/projects/{projectsId}/remoteConfig"
}
}
}
@@ -193,10 +193,10 @@
"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\").",
@@ -204,29 +204,35 @@
"location": "query"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"callback": {
+ "description": "JSONP",
"type": "string",
- "location": "query",
- "description": "JSONP"
+ "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"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -234,13 +240,7 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
+ "default": "json"
},
"key": {
"location": "query",
@@ -253,31 +253,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": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Pretty-print response."
- },
- "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"
+ },
+ "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://firebaseremoteconfig.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Firebase Remote Config API allows the 3P clients to manage Remote Config conditions and parameters for Firebase applications.",
"servicePath": "",
+ "description": "Firebase Remote Config API allows the 3P clients to manage Remote Config conditions and parameters for Firebase applications.",
+ "kind": "discovery#restDescription",
"basePath": ""
}
diff --git a/firebaserules/v1/firebaserules-api.json b/firebaserules/v1/firebaserules-api.json
index 63e0b87..93a90f6 100644
--- a/firebaserules/v1/firebaserules-api.json
+++ b/firebaserules/v1/firebaserules-api.json
@@ -1,37 +1,192 @@
{
"servicePath": "",
- "description": "Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.\n",
"kind": "discovery#restDescription",
+ "description": "Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.\n",
"basePath": "",
- "documentationLink": "https://firebase.google.com/docs/storage/security",
"revision": "20171108",
+ "documentationLink": "https://firebase.google.com/docs/storage/security",
"id": "firebaserules:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "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`.",
+ "Release": {
"type": "object",
"properties": {
- "args": {
+ "updateTime": {
+ "description": "Time the release was updated.\nOutput only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "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}`",
+ "type": "string"
+ },
+ "rulesetName": {
+ "description": "Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must\nexist the `Release` to be created.",
+ "type": "string"
+ },
+ "createTime": {
+ "type": "string",
+ "description": "Time the release was created.\nOutput only.",
+ "format": "google-datetime"
+ }
+ },
+ "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`."
+ },
+ "TestRulesetResponse": {
+ "id": "TestRulesetResponse",
+ "description": "The response for FirebaseRulesService.TestRuleset.",
+ "type": "object",
+ "properties": {
+ "issues": {
+ "description": "Syntactic and semantic `Source` issues of varying severity. Issues of\n`ERROR` severity will prevent tests from executing.",
"type": "array",
"items": {
- "$ref": "Arg"
- },
- "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."
+ "$ref": "Issue"
+ }
},
+ "testResults": {
+ "description": "The set of test results given the test cases in the `TestSuite`.\nThe results will appear in the same order as the test cases appear in the\n`TestSuite`.",
+ "type": "array",
+ "items": {
+ "$ref": "TestResult"
+ }
+ }
+ }
+ },
+ "TestResult": {
+ "type": "object",
+ "properties": {
+ "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.",
+ "Test is a success.",
+ "Test is a failure."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "SUCCESS",
+ "FAILURE"
+ ],
+ "description": "State of the test.",
+ "type": "string"
+ },
+ "debugMessages": {
+ "description": "Debug messages related to test execution issues encountered during\nevaluation.\n\nDebug messages may be related to too many or too few invocations of\nfunction mocks or to runtime errors that occur during evaluation.\n\nFor example: ```Unable to read variable [name: \"resource\"]```",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "errorPosition": {
+ "$ref": "SourcePosition",
+ "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 }`"
+ }
+ },
+ "id": "TestResult",
+ "description": "Test result message containing the state of the test as well as a\ndescription and source position for test failures."
+ },
+ "ListRulesetsResponse": {
+ "description": "The response for FirebaseRulesService.ListRulesets.",
+ "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"
+ },
+ "rulesets": {
+ "description": "List of `Ruleset` instances.",
+ "type": "array",
+ "items": {
+ "$ref": "Ruleset"
+ }
+ }
+ },
+ "id": "ListRulesetsResponse"
+ },
+ "Arg": {
+ "description": "Arg matchers for the mock function.",
+ "type": "object",
+ "properties": {
+ "exactValue": {
+ "type": "any",
+ "description": "Argument exactly matches value provided."
+ },
+ "anyValue": {
+ "description": "Argument matches any value provided.",
+ "$ref": "Empty"
+ }
+ },
+ "id": "Arg"
+ },
+ "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",
+ "properties": {
+ "testCases": {
+ "type": "array",
+ "items": {
+ "$ref": "TestCase"
+ },
+ "description": "Collection of test cases associated with the `TestSuite`."
+ }
+ },
+ "id": "TestSuite"
+ },
+ "UpdateReleaseRequest": {
+ "description": "The request for FirebaseRulesService.UpdateReleasePatch.",
+ "type": "object",
+ "properties": {
+ "updateMask": {
+ "description": "Specifies which fields to update.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "release": {
+ "$ref": "Release",
+ "description": "`Release` to update."
+ }
+ },
+ "id": "UpdateReleaseRequest"
+ },
+ "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": {}
+ },
+ "FunctionMock": {
+ "properties": {
"function": {
- "type": "string",
- "description": "The name of the function.\n\nThe function name must match one provided by a service declaration."
+ "description": "The name of the function.\n\nThe function name must match one provided by a service declaration.",
+ "type": "string"
},
"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.",
+ "type": "array",
+ "items": {
+ "$ref": "Arg"
+ }
}
},
- "id": "FunctionMock"
+ "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"
},
"GetReleaseExecutableResponse": {
+ "id": "GetReleaseExecutableResponse",
"description": "The response for FirebaseRulesService.GetReleaseExecutable",
"type": "object",
"properties": {
@@ -55,30 +210,29 @@
"description": "`Language` used to generate the executable bytes."
},
"rulesetName": {
- "type": "string",
- "description": "`Ruleset` name associated with the `Release` executable."
+ "description": "`Ruleset` name associated with the `Release` executable.",
+ "type": "string"
},
"executableVersion": {
+ "enumDescriptions": [
+ "Executable format unspecified.\nDefaults to FIREBASE_RULES_EXECUTABLE_V1",
+ "Firebase Rules syntax 'rules2' executable versions:\nCustom AST for use with Java clients.",
+ "CEL-based executable for use with C++ clients."
+ ],
"enum": [
"RELEASE_EXECUTABLE_VERSION_UNSPECIFIED",
"FIREBASE_RULES_EXECUTABLE_V1",
"FIREBASE_RULES_EXECUTABLE_V2"
],
"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.",
- "CEL-based executable for use with C++ clients."
- ]
+ "type": "string"
},
"executable": {
"description": "Executable view of the `Ruleset` referenced by the `Release`.",
"format": "byte",
"type": "string"
}
- },
- "id": "GetReleaseExecutableResponse"
+ }
},
"Source": {
"type": "object",
@@ -95,32 +249,31 @@
"description": "`Source` is one or more `File` messages comprising a logical set of rules."
},
"Result": {
+ "description": "Possible result values from the function mock invocation.",
"type": "object",
"properties": {
"value": {
- "type": "any",
- "description": "The result is an actual value. The type of the value must match that\nof the type declared by the service."
+ "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": {
"$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."
+ "id": "Result"
},
"SourcePosition": {
- "type": "object",
"properties": {
"line": {
- "type": "integer",
"description": "Line number of the source fragment. 1-based.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"column": {
- "type": "integer",
"description": "First column on the source line associated with the source fragment.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"fileName": {
"description": "Name of the `File`.",
@@ -128,7 +281,8 @@
}
},
"id": "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."
+ "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.",
+ "type": "object"
},
"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.",
@@ -146,6 +300,7 @@
}
},
"expectation": {
+ "description": "Test expectation.",
"type": "string",
"enumDescriptions": [
"Unspecified expectation.",
@@ -156,60 +311,19 @@
"EXPECTATION_UNSPECIFIED",
"ALLOW",
"DENY"
- ],
- "description": "Test expectation."
+ ]
},
"request": {
- "type": "any",
- "description": "Request context.\n\nThe exact format of the request context is service-dependent. See the\nappropriate service documentation for information about the supported\nfields and types on the request. Minimally, all services support the\nfollowing fields and types:\n\nRequest field | Type\n---------------|-----------------\nauth.uid | `string`\nauth.token | `map\u003cstring, string\u003e`\nheaders | `map\u003cstring, string\u003e`\nmethod | `string`\nparams | `map\u003cstring, string\u003e`\npath | `string`\ntime | `google.protobuf.Timestamp`\n\nIf the request value is not well-formed for the service, the request will\nbe rejected as an invalid argument."
+ "description": "Request context.\n\nThe exact format of the request context is service-dependent. See the\nappropriate service documentation for information about the supported\nfields and types on the request. Minimally, all services support the\nfollowing fields and types:\n\nRequest field | Type\n---------------|-----------------\nauth.uid | `string`\nauth.token | `map\u003cstring, string\u003e`\nheaders | `map\u003cstring, string\u003e`\nmethod | `string`\nparams | `map\u003cstring, string\u003e`\npath | `string`\ntime | `google.protobuf.Timestamp`\n\nIf the request value is not well-formed for the service, the request will\nbe rejected as an invalid argument.",
+ "type": "any"
}
},
"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": {
- "type": "string",
- "description": "Name of the `Ruleset`. The ruleset_id is auto generated by the service.\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`\nOutput only."
- }
- },
- "id": "Ruleset"
- },
- "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": {
- "$ref": "TestSuite",
- "description": "Inline `TestSuite` to run."
- }
- },
- "id": "TestRulesetRequest"
- },
"Issue": {
"type": "object",
"properties": {
- "sourcePosition": {
- "$ref": "SourcePosition",
- "description": "Position of the issue in the `Source`."
- },
"severity": {
- "type": "string",
"enumDescriptions": [
"An unspecified severity.",
"Deprecation issue for statements and method that may no longer be\nsupported or maintained.",
@@ -222,232 +336,118 @@
"WARNING",
"ERROR"
],
- "description": "The severity of the issue."
+ "description": "The severity of the issue.",
+ "type": "string"
},
"description": {
"description": "Short error description.",
"type": "string"
+ },
+ "sourcePosition": {
+ "$ref": "SourcePosition",
+ "description": "Position of the issue in the `Source`."
}
},
"id": "Issue",
"description": "Issues include warnings, errors, and deprecation notices."
},
- "File": {
+ "TestRulesetRequest": {
+ "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": {
+ "description": "Inline `TestSuite` to run.",
+ "$ref": "TestSuite"
+ }
+ },
+ "id": "TestRulesetRequest",
+ "description": "The request for FirebaseRulesService.TestRuleset.",
+ "type": "object"
+ },
+ "Ruleset": {
+ "description": "`Ruleset` is an immutable copy of `Source` with a globally unique identifier\nand a creation time.",
"type": "object",
"properties": {
- "content": {
+ "name": {
"type": "string",
- "description": "Textual Content."
+ "description": "Name of the `Ruleset`. The ruleset_id is auto generated by the service.\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`\nOutput only."
},
+ "source": {
+ "description": "`Source` for the `Ruleset`.",
+ "$ref": "Source"
+ },
+ "createTime": {
+ "description": "Time the `Ruleset` was created.\nOutput only.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Ruleset"
+ },
+ "File": {
+ "properties": {
"fingerprint": {
- "type": "string",
"description": "Fingerprint (e.g. github sha) associated with the `File`.",
- "format": "byte"
+ "format": "byte",
+ "type": "string"
},
"name": {
- "description": "File name.",
+ "type": "string",
+ "description": "File name."
+ },
+ "content": {
+ "description": "Textual Content.",
"type": "string"
}
},
"id": "File",
- "description": "`File` containing source content."
+ "description": "`File` containing source content.",
+ "type": "object"
},
"FunctionCall": {
+ "description": "Represents a service-defined function call that was invoked during test\nexecution.",
"type": "object",
"properties": {
"args": {
+ "description": "The arguments that were provided to the function.",
"type": "array",
"items": {
"type": "any"
- },
- "description": "The arguments that were provided to the function."
+ }
},
"function": {
"type": "string",
"description": "Name of the function invoked."
}
},
- "id": "FunctionCall",
- "description": "Represents a service-defined function call that was invoked during test\nexecution."
+ "id": "FunctionCall"
},
"ListReleasesResponse": {
- "description": "The response for FirebaseRulesService.ListReleases.",
- "type": "object",
"properties": {
- "nextPageToken": {
- "type": "string",
- "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain."
- },
"releases": {
+ "description": "List of `Release` instances.",
"type": "array",
"items": {
"$ref": "Release"
- },
- "description": "List of `Release` instances."
- }
- },
- "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.",
- "format": "google-datetime",
- "type": "string"
- },
- "updateTime": {
- "type": "string",
- "description": "Time the release was updated.\nOutput only.",
- "format": "google-datetime"
- },
- "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}`",
- "type": "string"
- },
- "rulesetName": {
- "description": "Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must\nexist the `Release` to be created.",
- "type": "string"
- }
- },
- "id": "Release"
- },
- "TestRulesetResponse": {
- "description": "The response for FirebaseRulesService.TestRuleset.",
- "type": "object",
- "properties": {
- "testResults": {
- "type": "array",
- "items": {
- "$ref": "TestResult"
- },
- "description": "The set of test results given the test cases in the `TestSuite`.\nThe results will appear in the same order as the test cases appear in the\n`TestSuite`."
- },
- "issues": {
- "description": "Syntactic and semantic `Source` issues of varying severity. Issues of\n`ERROR` severity will prevent tests from executing.",
- "type": "array",
- "items": {
- "$ref": "Issue"
}
- }
- },
- "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": {
- "functionCalls": {
- "type": "array",
- "items": {
- "$ref": "FunctionCall"
- },
- "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`."
},
- "state": {
- "type": "string",
- "enumDescriptions": [
- "Test state is not set.",
- "Test is a success.",
- "Test is a failure."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "SUCCESS",
- "FAILURE"
- ],
- "description": "State of the test."
- },
- "debugMessages": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Debug messages related to test execution issues encountered during\nevaluation.\n\nDebug messages may be related to too many or too few invocations of\nfunction mocks or to runtime errors that occur during evaluation.\n\nFor example: ```Unable to read variable [name: \"resource\"]```"
- },
- "errorPosition": {
- "$ref": "SourcePosition",
- "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 }`"
- }
- },
- "id": "TestResult"
- },
- "ListRulesetsResponse": {
- "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"
- },
- "rulesets": {
- "type": "array",
- "items": {
- "$ref": "Ruleset"
- },
- "description": "List of `Ruleset` instances."
}
},
- "id": "ListRulesetsResponse",
- "description": "The response for FirebaseRulesService.ListRulesets."
- },
- "Arg": {
- "type": "object",
- "properties": {
- "exactValue": {
- "description": "Argument exactly matches value provided.",
- "type": "any"
- },
- "anyValue": {
- "$ref": "Empty",
- "description": "Argument matches any value provided."
- }
- },
- "id": "Arg",
- "description": "Arg matchers for the mock function."
- },
- "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",
- "properties": {
- "testCases": {
- "description": "Collection of test cases associated with the `TestSuite`.",
- "type": "array",
- "items": {
- "$ref": "TestCase"
- }
- }
- },
- "id": "TestSuite"
- },
- "UpdateReleaseRequest": {
- "description": "The request for FirebaseRulesService.UpdateReleasePatch.",
- "type": "object",
- "properties": {
- "release": {
- "$ref": "Release",
- "description": "`Release` to update."
- },
- "updateMask": {
- "type": "string",
- "description": "Specifies which fields to update.",
- "format": "google-fieldmask"
- }
- },
- "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"
+ "id": "ListReleasesResponse",
+ "description": "The response for FirebaseRulesService.ListReleases.",
+ "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",
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
"canonicalName": "Firebase Rules",
"auth": {
"oauth2": {
@@ -474,6 +474,13 @@
"projects": {
"methods": {
"test": {
+ "flatPath": "v1/projects/{projectsId}:test",
+ "path": "v1/{+name}:test",
+ "id": "firebaserules.projects.test",
+ "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 }",
+ "request": {
+ "$ref": "TestRulesetRequest"
+ },
"response": {
"$ref": "TestRulesetResponse"
},
@@ -488,94 +495,113 @@
],
"parameters": {
"name": {
+ "pattern": "^projects/.+$",
"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/.+$"
+ "type": "string"
}
- },
- "flatPath": "v1/projects/{projectsId}:test",
- "path": "v1/{+name}:test",
- "id": "firebaserules.projects.test",
- "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 }",
- "request": {
- "$ref": "TestRulesetRequest"
}
}
},
"resources": {
"rulesets": {
"methods": {
- "get": {
- "httpMethod": "GET",
+ "delete": {
"response": {
- "$ref": "Ruleset"
+ "$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 ruleset to get.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/rulesets/[^/]+$"
+ "pattern": "^projects/[^/]+/rulesets/[^/]+$",
+ "location": "path",
+ "description": "Resource name for the ruleset to delete.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`"
}
},
+ "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."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Ruleset"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/rulesets/[^/]+$",
+ "location": "path",
+ "description": "Resource name for the ruleset to get.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`"
+ }
+ },
"flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}",
"id": "firebaserules.projects.rulesets.get",
"path": "v1/{+name}",
"description": "Get a `Ruleset` by name including the full `Source` contents."
},
"list": {
- "httpMethod": "GET",
+ "flatPath": "v1/projects/{projectsId}/rulesets",
+ "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": {
+ "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",
- "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`"
+ "location": "path"
},
"pageToken": {
+ "description": "Next page token for loading the next batch of `Ruleset` instances.",
"type": "string",
- "location": "query",
- "description": "Next page token for loading the next batch of `Ruleset` instances."
+ "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"
- },
- "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"
}
- },
- "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",
- "id": "firebaserules.projects.rulesets.list",
- "path": "v1/{+name}/rulesets",
- "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."
+ }
},
"create": {
"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.",
@@ -595,62 +621,36 @@
],
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+$",
"location": "path",
"description": "Resource name for Project which owns this `Ruleset`.\n\nFormat: `projects/{project_id}`",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
+ "type": "string"
}
},
"flatPath": "v1/projects/{projectsId}/rulesets",
"path": "v1/{+name}/rulesets",
"id": "firebaserules.projects.rulesets.create"
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/rulesets/[^/]+$",
- "location": "path",
- "description": "Resource name for the ruleset to delete.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
- "flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}",
- "id": "firebaserules.projects.rulesets.delete",
- "path": "v1/{+name}",
- "description": "Delete a `Ruleset` by resource name.\n\nIf the `Ruleset` is referenced by a `Release` the operation will fail."
}
}
},
"releases": {
"methods": {
- "delete": {
- "httpMethod": "DELETE",
+ "update": {
"response": {
- "$ref": "Empty"
+ "$ref": "Release"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "PUT",
"parameters": {
"name": {
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/releases/.+$",
"location": "path",
- "description": "Resource name for the `Release` to delete.\n\nFormat: `projects/{project_id}/releases/{release_id}`"
+ "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}`"
}
},
"scopes": [
@@ -658,35 +658,39 @@
"https://www.googleapis.com/auth/firebase"
],
"flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
- "id": "firebaserules.projects.releases.delete",
"path": "v1/{+name}",
- "description": "Delete a `Release` by resource name."
+ "id": "firebaserules.projects.releases.update",
+ "request": {
+ "$ref": "Release"
+ },
+ "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."
},
"getExecutable": {
- "httpMethod": "GET",
+ "description": "Get the `Release` executable to use when enforcing rules.",
"response": {
"$ref": "GetReleaseExecutableResponse"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "GET",
"parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/releases/.+$",
- "location": "path",
- "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`"
- },
"executableVersion": {
+ "type": "string",
"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"
+ "description": "The requested runtime executable version.\nDefaults to FIREBASE_RULES_EXECUTABLE_V1"
+ },
+ "name": {
+ "location": "path",
+ "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/releases/.+$"
}
},
"scopes": [
@@ -695,42 +699,66 @@
"https://www.googleapis.com/auth/firebase.readonly"
],
"flatPath": "v1/projects/{projectsId}/releases/{releasesId}:getExecutable",
- "id": "firebaserules.projects.releases.getExecutable",
"path": "v1/{+name}:getExecutable",
- "description": "Get the `Release` executable to use when enforcing rules."
+ "id": "firebaserules.projects.releases.getExecutable"
+ },
+ "delete": {
+ "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
+ "id": "firebaserules.projects.releases.delete",
+ "path": "v1/{+name}",
+ "description": "Delete a `Release` by resource name.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/releases/.+$",
+ "location": "path",
+ "description": "Resource name for the `Release` to delete.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ]
},
"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.",
- "httpMethod": "GET",
"response": {
"$ref": "ListReleasesResponse"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "GET",
"parameters": {
- "filter": {
- "type": "string",
- "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`"
- },
"name": {
- "required": true,
- "type": "string",
"pattern": "^projects/[^/]+$",
"location": "path",
- "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`"
+ "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
+ "required": true,
+ "type": "string"
},
"pageToken": {
- "type": "string",
"location": "query",
- "description": "Next page token for the next batch of `Release` instances."
+ "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"
+ "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"
}
},
"scopes": [
@@ -739,17 +767,17 @@
"https://www.googleapis.com/auth/firebase.readonly"
],
"flatPath": "v1/projects/{projectsId}/releases",
+ "path": "v1/{+name}/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",
- "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.",
"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"
},
@@ -757,28 +785,22 @@
"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": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`"
- }
- }
+ "flatPath": "v1/projects/{projectsId}/releases"
},
"patch": {
- "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
- "path": "v1/{+name}",
- "id": "firebaserules.projects.releases.patch",
- "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.",
- "request": {
- "$ref": "UpdateReleaseRequest"
- },
"response": {
"$ref": "Release"
},
@@ -798,9 +820,17 @@
"location": "path",
"description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`"
}
+ },
+ "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
+ "path": "v1/{+name}",
+ "id": "firebaserules.projects.releases.patch",
+ "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.",
+ "request": {
+ "$ref": "UpdateReleaseRequest"
}
},
"get": {
+ "description": "Get a `Release` by name.",
"response": {
"$ref": "Release"
},
@@ -815,46 +845,16 @@
],
"parameters": {
"name": {
- "required": true,
- "type": "string",
"pattern": "^projects/[^/]+/releases/.+$",
"location": "path",
- "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`"
+ "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."
- },
- "update": {
- "request": {
- "$ref": "Release"
- },
- "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.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Release"
- },
- "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/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
- "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
- "id": "firebaserules.projects.releases.update",
- "path": "v1/{+name}"
+ "id": "firebaserules.projects.releases.get"
}
}
}
@@ -862,11 +862,26 @@
}
},
"parameters": {
- "pp": {
- "type": "boolean",
- "default": "true",
+ "access_token": {
"location": "query",
- "description": "Pretty-print response."
+ "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": {
+ "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",
@@ -874,9 +889,9 @@
"type": "string"
},
"bearer_token": {
- "type": "string",
"location": "query",
- "description": "OAuth bearer token."
+ "description": "OAuth bearer token.",
+ "type": "string"
},
"upload_protocol": {
"type": "string",
@@ -884,21 +899,21 @@
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
"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."
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "default": "true"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
+ "fields": {
+ "type": "string",
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response."
+ },
"$.xgafv": {
"location": "query",
"enum": [
@@ -913,11 +928,16 @@
]
},
"callback": {
+ "type": "string",
"location": "query",
- "description": "JSONP",
- "type": "string"
+ "description": "JSONP"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -926,27 +946,7 @@
],
"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": {
- "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"
+ "default": "json"
}
},
"version": "v1",
diff --git a/firestore/v1beta1/firestore-api.json b/firestore/v1beta1/firestore-api.json
index 5b2b2d6..a6696e4 100644
--- a/firestore/v1beta1/firestore-api.json
+++ b/firestore/v1beta1/firestore-api.json
@@ -1,29 +1,367 @@
{
+ "basePath": "",
+ "revision": "20171212",
"documentationLink": "https://cloud.google.com/firestore",
"id": "firestore:v1beta1",
- "revision": "20171205",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "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"
+ }
+ },
+ "id": "CollectionSelector"
+ },
+ "ArrayValue": {
+ "description": "An array value.",
+ "type": "object",
+ "properties": {
+ "values": {
+ "description": "Values in the array.",
+ "type": "array",
+ "items": {
+ "$ref": "Value"
+ }
+ }
+ },
+ "id": "ArrayValue"
+ },
+ "Index": {
+ "description": "An index definition.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "The fields to index.",
+ "type": "array",
+ "items": {
+ "$ref": "IndexField"
+ }
+ },
+ "state": {
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "CREATING",
+ "READY",
+ "ERROR"
+ ],
+ "description": "The state of the index.\nOutput only.",
+ "type": "string",
+ "enumDescriptions": [
+ "The state is unspecified.",
+ "The index is being created.\nThere is an active long-running operation for the index.\nThe index is updated when writing a document.\nSome index data may exist.",
+ "The index is ready to be used.\nThe index is updated when writing a document.\nThe index is fully populated from all stored documents it applies to.",
+ "The index was being created, but something went wrong.\nThere is no active long-running operation for the index,\nand the most recently finished long-running operation failed.\nThe index is not updated when writing a document.\nSome index data may exist."
+ ]
+ },
+ "name": {
+ "description": "The resource name of the index.\nOutput only.",
+ "type": "string"
+ },
+ "collectionId": {
+ "description": "The collection ID to which this index applies. Required.",
+ "type": "string"
+ }
+ },
+ "id": "Index"
+ },
+ "StructuredQuery": {
+ "properties": {
+ "limit": {
+ "description": "The maximum number of results to return.\n\nApplies after all other constraints.\nMust be \u003e= 0 if specified.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "offset": {
+ "description": "The number of results to skip.\n\nApplies before limit, but after all other constraints. Must be \u003e= 0 if\nspecified.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "from": {
+ "description": "The collections to query.",
+ "type": "array",
+ "items": {
+ "$ref": "CollectionSelector"
+ }
+ },
+ "endAt": {
+ "$ref": "Cursor",
+ "description": "A end point for the query results."
+ },
+ "startAt": {
+ "$ref": "Cursor",
+ "description": "A starting point for the query results."
+ },
+ "where": {
+ "$ref": "Filter",
+ "description": "The filter to apply."
+ },
+ "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": {
+ "description": "The projection to return.",
+ "$ref": "Projection"
+ }
+ },
+ "id": "StructuredQuery",
+ "description": "A Firestore query.",
+ "type": "object"
+ },
+ "UnaryFilter": {
+ "description": "A filter with a single operand.",
+ "type": "object",
+ "properties": {
+ "op": {
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Test if a field is equal to NaN.",
+ "Test if an exprestion evaluates to Null."
+ ],
+ "enum": [
+ "OPERATOR_UNSPECIFIED",
+ "IS_NAN",
+ "IS_NULL"
+ ],
+ "description": "The unary operator to apply.",
+ "type": "string"
+ },
+ "field": {
+ "description": "The field to which to apply the operator.",
+ "$ref": "FieldReference"
+ }
+ },
+ "id": "UnaryFilter"
+ },
+ "Filter": {
+ "description": "A filter.",
+ "type": "object",
+ "properties": {
+ "unaryFilter": {
+ "$ref": "UnaryFilter",
+ "description": "A filter that takes exactly one argument."
+ },
+ "compositeFilter": {
+ "description": "A composite filter.",
+ "$ref": "CompositeFilter"
+ },
+ "fieldFilter": {
+ "description": "A filter on a document field.",
+ "$ref": "FieldFilter"
+ }
+ },
+ "id": "Filter"
+ },
+ "WriteRequest": {
+ "properties": {
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "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"
+ },
+ "BatchGetDocumentsResponse": {
+ "description": "The streamed response for Firestore.BatchGetDocuments.",
+ "type": "object",
+ "properties": {
+ "transaction": {
+ "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"
+ },
+ "found": {
+ "$ref": "Document",
+ "description": "A document that was requested."
+ },
+ "missing": {
+ "description": "A document name that was requested but does not exist. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
+ "type": "string"
+ }
+ },
+ "id": "BatchGetDocumentsResponse"
+ },
+ "Target": {
+ "description": "A specification of a set of documents to listen to.",
+ "type": "object",
+ "properties": {
+ "query": {
+ "description": "A target specified by a query.",
+ "$ref": "QueryTarget"
+ },
+ "resumeToken": {
+ "description": "A resume token from a prior TargetChange for an identical target.\n\nUsing a resume token with a different target is unsupported and may fail.",
+ "format": "byte",
+ "type": "string"
+ },
+ "once": {
+ "description": "If the target should be removed once it is current and consistent.",
+ "type": "boolean"
+ },
+ "readTime": {
+ "description": "Start listening after a specific `read_time`.\n\nThe client must know the state of matching documents at this time.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "targetId": {
+ "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": {
+ "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"
+ },
+ "RunQueryRequest": {
+ "description": "The request for Firestore.RunQuery.",
+ "type": "object",
+ "properties": {
+ "readTime": {
+ "description": "Reads documents as they were at the given time.\nThis may not be older than 60 seconds.",
+ "format": "google-datetime",
+ "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."
+ },
+ "transaction": {
+ "description": "Reads documents in a transaction.",
+ "format": "byte",
+ "type": "string"
+ },
+ "structuredQuery": {
+ "$ref": "StructuredQuery",
+ "description": "A structured query."
+ }
+ },
+ "id": "RunQueryRequest"
+ },
+ "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"
+ }
+ }
+ },
+ "id": "ListIndexesResponse"
+ },
+ "TransactionOptions": {
+ "properties": {
+ "readOnly": {
+ "$ref": "ReadOnly",
+ "description": "The transaction can only be used for read operations."
+ },
+ "readWrite": {
+ "$ref": "ReadWrite",
+ "description": "The transaction can be used for both read and write operations."
+ }
+ },
+ "id": "TransactionOptions",
+ "description": "Options for creating a new transaction.",
+ "type": "object"
+ },
+ "FieldReference": {
+ "description": "A reference to a field, such as `max(messages.time) as max_time`.",
+ "type": "object",
+ "properties": {
+ "fieldPath": {
+ "type": "string"
+ }
+ },
+ "id": "FieldReference"
+ },
"ListenResponse": {
"description": "The response for Firestore.Listen.",
"type": "object",
"properties": {
"documentDelete": {
- "$ref": "DocumentDelete",
- "description": "A Document has been deleted."
+ "description": "A Document has been deleted.",
+ "$ref": "DocumentDelete"
},
"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"
+ "$ref": "DocumentChange",
+ "description": "A Document has changed."
},
"targetChange": {
- "description": "Targets have changed.",
- "$ref": "TargetChange"
+ "$ref": "TargetChange",
+ "description": "Targets have changed."
},
"documentRemove": {
"$ref": "DocumentRemove",
@@ -33,6 +371,8 @@
"id": "ListenResponse"
},
"ListCollectionIdsRequest": {
+ "description": "The request for Firestore.ListCollectionIds.",
+ "type": "object",
"properties": {
"pageSize": {
"description": "The maximum number of results to return.",
@@ -44,26 +384,24 @@
"type": "string"
}
},
- "id": "ListCollectionIdsRequest",
- "description": "The request for Firestore.ListCollectionIds.",
- "type": "object"
+ "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.",
- "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.",
"format": "int32",
"type": "integer"
+ },
+ "targetId": {
+ "description": "The target ID to which this filter applies.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "ExistenceFilter"
+ "id": "ExistenceFilter",
+ "description": "A digest of all the documents that match a given target.",
+ "type": "object"
},
"WriteResult": {
"description": "The result of applying a write.",
@@ -100,18 +438,6 @@
"description": "A message that can hold any of the supported value types.",
"type": "object",
"properties": {
- "stringValue": {
- "description": "A string value.\n\nThe string, represented as UTF-8, must not exceed 1 MiB - 89 bytes.\nOnly the first 1,500 bytes of the UTF-8 representation are considered by\nqueries.",
- "type": "string"
- },
- "referenceValue": {
- "description": "A reference to a document. For example:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
- "type": "string"
- },
- "arrayValue": {
- "$ref": "ArrayValue",
- "description": "An array value.\n\nCannot contain another array value."
- },
"doubleValue": {
"description": "A double value.",
"format": "double",
@@ -122,6 +448,10 @@
"format": "google-datetime",
"type": "string"
},
+ "booleanValue": {
+ "description": "A boolean value.",
+ "type": "boolean"
+ },
"nullValue": {
"enumDescriptions": [
"Null value."
@@ -132,10 +462,6 @@
"description": "A null value.",
"type": "string"
},
- "booleanValue": {
- "description": "A boolean value.",
- "type": "boolean"
- },
"mapValue": {
"$ref": "MapValue",
"description": "A map value."
@@ -153,11 +479,25 @@
"description": "An integer value.",
"format": "int64",
"type": "string"
+ },
+ "arrayValue": {
+ "description": "An array value.\n\nCannot contain another array value.",
+ "$ref": "ArrayValue"
+ },
+ "referenceValue": {
+ "description": "A reference to a document. For example:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
+ "type": "string"
+ },
+ "stringValue": {
+ "description": "A string value.\n\nThe string, represented as UTF-8, must not exceed 1 MiB - 89 bytes.\nOnly the first 1,500 bytes of the UTF-8 representation are considered by\nqueries.",
+ "type": "string"
}
},
"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.",
@@ -171,21 +511,15 @@
}
}
},
- "id": "Cursor",
- "description": "A position in a query result set.",
- "type": "object"
+ "id": "Cursor"
},
"Write": {
"description": "A write on a document.",
"type": "object",
"properties": {
- "delete": {
- "description": "A document name to delete. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
- "type": "string"
- },
"updateMask": {
- "$ref": "DocumentMask",
- "description": "The fields to update in this write.\n\nThis field can be set only when the operation is `update`.\nNone of the field paths in the mask may contain a reserved name.\nIf the document exists on the server and has fields not referenced in the\nmask, they are left unchanged.\nFields referenced in the mask, but not present in the input document, are\ndeleted from the document on the server.\nThe field paths in this mask must not contain a reserved field name."
+ "description": "The fields to update in this write.\n\nThis field can be set only when the operation is `update`.\nNone of the field paths in the mask may contain a reserved name.\nIf the document exists on the server and has fields not referenced in the\nmask, they are left unchanged.\nFields referenced in the mask, but not present in the input document, are\ndeleted from the document on the server.\nThe field paths in this mask must not contain a reserved field name.",
+ "$ref": "DocumentMask"
},
"currentDocument": {
"$ref": "Precondition",
@@ -198,6 +532,10 @@
"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."
+ },
+ "delete": {
+ "description": "A document name to delete. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
+ "type": "string"
}
},
"id": "Write"
@@ -215,20 +553,9 @@
"id": "ReadWrite"
},
"BatchGetDocumentsRequest": {
+ "description": "The request for Firestore.BatchGetDocuments.",
+ "type": "object",
"properties": {
- "readTime": {
- "description": "Reads documents as they were at the given time.\nThis may not be older than 60 seconds.",
- "format": "google-datetime",
- "type": "string"
- },
- "newTransaction": {
- "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"
- },
- "mask": {
- "$ref": "DocumentMask",
- "description": "The fields to return. If not set, returns all fields.\n\nIf a document has a field that is not present in this mask, that field will\nnot be returned in the response."
- },
"transaction": {
"description": "Reads documents in a transaction.",
"format": "byte",
@@ -240,11 +567,49 @@
"items": {
"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"
+ },
+ "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."
+ },
+ "mask": {
+ "description": "The fields to return. If not set, returns all fields.\n\nIf a document has a field that is not present in this mask, that field will\nnot be returned in the response.",
+ "$ref": "DocumentMask"
}
},
- "id": "BatchGetDocumentsRequest",
- "description": "The request for Firestore.BatchGetDocuments.",
- "type": "object"
+ "id": "BatchGetDocumentsRequest"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "removedTargetIds": {
+ "description": "A set of target IDs for targets that no longer match this document.",
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "id": "DocumentChange"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
@@ -255,12 +620,12 @@
"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"
},
"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.",
@@ -281,33 +646,6 @@
},
"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.",
- "type": "object",
- "properties": {
- "removedTargetIds": {
- "description": "A set of target IDs for targets that no longer match this document.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- },
- "document": {
- "description": "The new state of the Document.\n\nIf `mask` is set, contains only fields that were updated or added.",
- "$ref": "Document"
- },
- "targetIds": {
- "description": "A set of target IDs of targets that match this document.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "id": "DocumentChange"
- },
"QueryTarget": {
"description": "A target specified by a query.",
"type": "object",
@@ -324,12 +662,9 @@
"id": "QueryTarget"
},
"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"
@@ -344,11 +679,14 @@
},
"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"
+ "id": "Status"
},
"Document": {
"description": "A Firestore document.\n\nMust not exceed 1 MiB - 4 bytes.",
@@ -360,11 +698,11 @@
"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.",
@@ -396,11 +734,6 @@
"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",
@@ -412,6 +745,11 @@
"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"
@@ -458,6 +796,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."
@@ -465,9 +805,7 @@
"enum": [
"OPERATOR_UNSPECIFIED",
"AND"
- ],
- "description": "The operator for combining multiple filters.",
- "type": "string"
+ ]
}
},
"id": "CompositeFilter"
@@ -501,8 +839,6 @@
"id": "DocumentMask"
},
"DocumentTransform": {
- "description": "A transformation of a document.",
- "type": "object",
"properties": {
"document": {
"description": "The name of the document to transform.",
@@ -516,30 +852,32 @@
}
}
},
- "id": "DocumentTransform"
+ "id": "DocumentTransform",
+ "description": "A transformation of a document.",
+ "type": "object"
},
"FieldTransform": {
+ "description": "A transformation of a field of the document.",
+ "type": "object",
"properties": {
"setToServerValue": {
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "The time at which the server processed the request, with millisecond\nprecision."
- ],
"enum": [
"SERVER_VALUE_UNSPECIFIED",
"REQUEST_TIME"
],
"description": "Sets the field to the given server value.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "The time at which the server processed the request, with millisecond\nprecision."
+ ]
},
"fieldPath": {
"description": "The path of the field. See Document.fields for the field path syntax\nreference.",
"type": "string"
}
},
- "id": "FieldTransform",
- "description": "A transformation of a field of the document.",
- "type": "object"
+ "id": "FieldTransform"
},
"ListCollectionIdsResponse": {
"description": "The response from Firestore.ListCollectionIds.",
@@ -563,17 +901,17 @@
"description": "The response for Firestore.Commit.",
"type": "object",
"properties": {
+ "commitTime": {
+ "description": "The time at which the commit occurred.",
+ "format": "google-datetime",
+ "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"
}
- },
- "commitTime": {
- "description": "The time at which the commit occurred.",
- "format": "google-datetime",
- "type": "string"
}
},
"id": "CommitResponse"
@@ -582,23 +920,23 @@
"description": "An order on a field.",
"type": "object",
"properties": {
- "field": {
- "$ref": "FieldReference",
- "description": "The field to order by."
- },
"direction": {
+ "enum": [
+ "DIRECTION_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
"description": "The direction to order by. Defaults to `ASCENDING`.",
"type": "string",
"enumDescriptions": [
"Unspecified.",
"Ascending.",
"Descending."
- ],
- "enum": [
- "DIRECTION_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
]
+ },
+ "field": {
+ "$ref": "FieldReference",
+ "description": "The field to order by."
}
},
"id": "Order"
@@ -636,14 +974,22 @@
"type": "object",
"properties": {
"field": {
- "description": "The field to filter by.",
- "$ref": "FieldReference"
+ "$ref": "FieldReference",
+ "description": "The field to filter by."
},
"value": {
"description": "The value to compare to.",
"$ref": "Value"
},
"op": {
+ "enumDescriptions": [
+ "Unspecified. This value must not be used.",
+ "Less than. Requires that the field come first in `order_by`.",
+ "Less than or equal. Requires that the field come first in `order_by`.",
+ "Greater than. Requires that the field come first in `order_by`.",
+ "Greater than or equal. Requires that the field come first in\n`order_by`.",
+ "Equal."
+ ],
"enum": [
"OPERATOR_UNSPECIFIED",
"LESS_THAN",
@@ -653,23 +999,18 @@
"EQUAL"
],
"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`.",
- "Less than or equal. Requires that the field come first in `order_by`.",
- "Greater than. Requires that the field come first in `order_by`.",
- "Greater than or equal. Requires that the field come first in\n`order_by`.",
- "Equal."
- ]
+ "type": "string"
}
},
"id": "FieldFilter"
},
"TargetChange": {
- "description": "Targets being watched have changed.",
- "type": "object",
"properties": {
+ "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.",
+ "format": "byte",
+ "type": "string"
+ },
"targetIds": {
"description": "The target IDs of targets that have changed.\n\nIf empty, the change applies to all targets.\n\nFor `target_change_type=ADD`, the order of the target IDs matches the order\nof the requests to add the targets. This allows clients to unambiguously\nassociate server-assigned target IDs with added targets.\n\nFor other states, the order of the target IDs is not defined.",
"type": "array",
@@ -688,6 +1029,8 @@
"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.",
@@ -701,17 +1044,12 @@
"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.",
- "format": "byte",
- "type": "string"
+ ]
}
},
- "id": "TargetChange"
+ "id": "TargetChange",
+ "description": "Targets being watched have changed.",
+ "type": "object"
},
"MapValue": {
"description": "A map value.",
@@ -789,6 +1127,8 @@
"id": "IndexField"
},
"RunQueryResponse": {
+ "description": "The response for Firestore.RunQuery.",
+ "type": "object",
"properties": {
"transaction": {
"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.",
@@ -796,8 +1136,8 @@
"type": "string"
},
"document": {
- "$ref": "Document",
- "description": "A query result.\nNot set when reporting partial progress."
+ "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.",
@@ -810,22 +1150,22 @@
"type": "integer"
}
},
- "id": "RunQueryResponse",
- "description": "The response for Firestore.RunQuery.",
- "type": "object"
+ "id": "RunQueryResponse"
},
"BeginTransactionRequest": {
- "description": "The request for Firestore.BeginTransaction.",
- "type": "object",
"properties": {
"options": {
"$ref": "TransactionOptions",
"description": "The options for the transaction.\nDefaults to a read-write transaction."
}
},
- "id": "BeginTransactionRequest"
+ "id": "BeginTransactionRequest",
+ "description": "The request for Firestore.BeginTransaction.",
+ "type": "object"
},
"CommitRequest": {
+ "description": "The request for Firestore.Commit.",
+ "type": "object",
"properties": {
"transaction": {
"description": "If set, applies all writes in this transaction, and commits it.",
@@ -840,16 +1180,12 @@
}
}
},
- "id": "CommitRequest",
- "description": "The request for Firestore.Commit.",
- "type": "object"
+ "id": "CommitRequest"
},
"ListenRequest": {
+ "description": "A request for Firestore.Listen",
+ "type": "object",
"properties": {
- "addTarget": {
- "description": "A target to add to this stream.",
- "$ref": "Target"
- },
"labels": {
"additionalProperties": {
"type": "string"
@@ -861,13 +1197,17 @@
"description": "The ID of a target to remove from this stream.",
"format": "int32",
"type": "integer"
+ },
+ "addTarget": {
+ "description": "A target to add to this stream.",
+ "$ref": "Target"
}
},
- "id": "ListenRequest",
- "description": "A request for Firestore.Listen",
- "type": "object"
+ "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].",
@@ -880,362 +1220,23 @@
"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"
- },
- "CollectionSelector": {
- "properties": {
- "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",
- "description": "A selection of a collection, such as `messages as m1`.",
- "type": "object"
- },
- "ArrayValue": {
- "description": "An array value.",
- "type": "object",
- "properties": {
- "values": {
- "description": "Values in the array.",
- "type": "array",
- "items": {
- "$ref": "Value"
- }
- }
- },
- "id": "ArrayValue"
- },
- "Index": {
- "description": "An index definition.",
- "type": "object",
- "properties": {
- "fields": {
- "description": "The fields to index.",
- "type": "array",
- "items": {
- "$ref": "IndexField"
- }
- },
- "state": {
- "enumDescriptions": [
- "The state is unspecified.",
- "The index is being created.\nThere is an active long-running operation for the index.\nThe index is updated when writing a document.\nSome index data may exist.",
- "The index is ready to be used.\nThe index is updated when writing a document.\nThe index is fully populated from all stored documents it applies to.",
- "The index was being created, but something went wrong.\nThere is no active long-running operation for the index,\nand the most recently finished long-running operation failed.\nThe index is not updated when writing a document.\nSome index data may exist."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "CREATING",
- "READY",
- "ERROR"
- ],
- "description": "The state of the index.\nOutput only.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the index.\nOutput only.",
- "type": "string"
- },
- "collectionId": {
- "description": "The collection ID to which this index applies. Required.",
- "type": "string"
- }
- },
- "id": "Index"
- },
- "StructuredQuery": {
- "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": {
- "description": "The projection to return.",
- "$ref": "Projection"
- },
- "limit": {
- "description": "The maximum number of results to return.\n\nApplies after all other constraints.\nMust be \u003e= 0 if specified.",
- "format": "int32",
- "type": "integer"
- },
- "from": {
- "description": "The collections to query.",
- "type": "array",
- "items": {
- "$ref": "CollectionSelector"
- }
- },
- "offset": {
- "description": "The number of results to skip.\n\nApplies before limit, but after all other constraints. Must be \u003e= 0 if\nspecified.",
- "format": "int32",
- "type": "integer"
- },
- "endAt": {
- "description": "A end point for the query results.",
- "$ref": "Cursor"
- },
- "startAt": {
- "$ref": "Cursor",
- "description": "A starting point for the query results."
- },
- "where": {
- "description": "The filter to apply.",
- "$ref": "Filter"
- }
- },
- "id": "StructuredQuery",
- "description": "A Firestore query.",
- "type": "object"
- },
- "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",
- "enumDescriptions": [
- "Unspecified. This value must not be used.",
- "Test if a field is equal to NaN.",
- "Test if an exprestion evaluates to Null."
- ],
- "enum": [
- "OPERATOR_UNSPECIFIED",
- "IS_NAN",
- "IS_NULL"
- ]
- }
- },
- "id": "UnaryFilter"
- },
- "Filter": {
- "properties": {
- "fieldFilter": {
- "description": "A filter on a document field.",
- "$ref": "FieldFilter"
- },
- "unaryFilter": {
- "description": "A filter that takes exactly one argument.",
- "$ref": "UnaryFilter"
- },
- "compositeFilter": {
- "description": "A composite filter.",
- "$ref": "CompositeFilter"
- }
- },
- "id": "Filter",
- "description": "A filter.",
- "type": "object"
- },
- "WriteRequest": {
- "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": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels associated with this write request.",
- "type": "object"
- }
- },
- "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"
- },
- "BatchGetDocumentsResponse": {
- "description": "The streamed response for Firestore.BatchGetDocuments.",
- "type": "object",
- "properties": {
- "found": {
- "description": "A document that was requested.",
- "$ref": "Document"
- },
- "missing": {
- "description": "A document name that was requested but does not exist. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
- "type": "string"
- },
- "transaction": {
- "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"
- },
- "Target": {
- "description": "A specification of a set of documents to listen to.",
- "type": "object",
- "properties": {
- "query": {
- "$ref": "QueryTarget",
- "description": "A target specified by a query."
- },
- "resumeToken": {
- "description": "A resume token from a prior TargetChange for an identical target.\n\nUsing a resume token with a different target is unsupported and may fail.",
- "format": "byte",
- "type": "string"
- },
- "once": {
- "description": "If the target should be removed once it is current and consistent.",
- "type": "boolean"
- },
- "readTime": {
- "description": "Start listening after a specific `read_time`.\n\nThe client must know the state of matching documents at this time.",
- "format": "google-datetime",
- "type": "string"
- },
- "targetId": {
- "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": {
- "description": "A target specified by a set of document names.",
- "$ref": "DocumentsTarget"
- }
- },
- "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",
- "properties": {
- "transaction": {
- "description": "Reads documents in a transaction.",
- "format": "byte",
- "type": "string"
- },
- "structuredQuery": {
- "$ref": "StructuredQuery",
- "description": "A structured query."
- },
- "readTime": {
- "description": "Reads documents as they were at the given time.\nThis may not be older than 60 seconds.",
- "format": "google-datetime",
- "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."
- }
- },
- "id": "RunQueryRequest"
- },
- "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"
- }
- }
- },
- "id": "ListIndexesResponse"
- },
- "TransactionOptions": {
- "properties": {
- "readOnly": {
- "description": "The transaction can only be used for read operations.",
- "$ref": "ReadOnly"
- },
- "readWrite": {
- "description": "The transaction can be used for both read and write operations.",
- "$ref": "ReadWrite"
- }
- },
- "id": "TransactionOptions",
- "description": "Options for creating a new transaction.",
- "type": "object"
- },
- "FieldReference": {
- "properties": {
- "fieldPath": {
- "type": "string"
- }
- },
- "id": "FieldReference",
- "description": "A reference to a field, such as `max(messages.time) as max_time`.",
- "type": "object"
+ "id": "LatLng"
}
},
"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": {
"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"
+ },
+ "https://www.googleapis.com/auth/datastore": {
+ "description": "View and manage your Google Cloud Datastore data"
}
}
}
@@ -1256,20 +1257,20 @@
"methods": {
"delete": {
"description": "Deletes an index.",
+ "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
"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"
+ "type": "string",
+ "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -1277,39 +1278,40 @@
"https://www.googleapis.com/auth/datastore"
],
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}",
- "path": "v1beta1/{+name}",
- "id": "firestore.projects.databases.indexes.delete"
+ "id": "firestore.projects.databases.indexes.delete",
+ "path": "v1beta1/{+name}"
},
"list": {
+ "description": "Lists the indexes that match the specified filters.",
"httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
"response": {
"$ref": "ListIndexesResponse"
},
+ "parameterOrder": [
+ "parent"
+ ],
"parameters": {
- "pageSize": {
- "location": "query",
- "description": "The standard List page size.",
- "format": "int32",
- "type": "integer"
- },
"parent": {
- "pattern": "^projects/[^/]+/databases/[^/]+$",
- "location": "path",
"description": "The database name. For example:\n`projects/{project_id}/databases/{database_id}`",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/databases/[^/]+$",
+ "location": "path"
},
"filter": {
"location": "query",
"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"
}
},
"scopes": [
@@ -1318,8 +1320,7 @@
],
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes",
"id": "firestore.projects.databases.indexes.list",
- "path": "v1beta1/{+parent}/indexes",
- "description": "Lists the indexes that match the specified filters."
+ "path": "v1beta1/{+parent}/indexes"
},
"get": {
"response": {
@@ -1335,11 +1336,11 @@
],
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$",
"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/[^/]+$"
+ "type": "string"
}
},
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}",
@@ -1348,33 +1349,33 @@
"description": "Gets an index."
},
"create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
"response": {
"$ref": "Operation"
},
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "The name of the database this index will apply to. For example:\n`projects/{project_id}/databases/{database_id}`",
- "required": true,
- "type": "string"
- }
- },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "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/[^/]+$"
+ }
+ },
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes",
- "id": "firestore.projects.databases.indexes.create",
"path": "v1beta1/{+parent}/indexes",
+ "id": "firestore.projects.databases.indexes.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"
- },
- "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."
+ }
}
}
},
@@ -1388,6 +1389,10 @@
"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.",
@@ -1397,50 +1402,50 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
"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"
- },
- "description": "Streams batches of document updates and deletes, in order."
+ }
},
- "batchGet": {
+ "beginTransaction": {
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:beginTransaction",
+ "path": "v1beta1/{+database}/documents:beginTransaction",
+ "id": "firestore.projects.databases.documents.beginTransaction",
+ "description": "Starts a new transaction.",
"request": {
- "$ref": "BatchGetDocumentsRequest"
+ "$ref": "BeginTransactionRequest"
},
- "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"
+ "$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:batchGet",
- "path": "v1beta1/{+database}/documents:batchGet",
- "id": "firestore.projects.databases.documents.batchGet"
+ "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"
+ }
+ }
},
- "beginTransaction": {
+ "batchGet": {
+ "description": "Gets multiple documents.\n\nDocuments returned by this method are not guaranteed to be returned in the\nsame order that they were requested.",
+ "request": {
+ "$ref": "BatchGetDocumentsRequest"
+ },
"response": {
- "$ref": "BeginTransactionResponse"
+ "$ref": "BatchGetDocumentsResponse"
},
"parameterOrder": [
"database"
@@ -1459,16 +1464,13 @@
"pattern": "^projects/[^/]+/databases/[^/]+$"
}
},
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:beginTransaction",
- "path": "v1beta1/{+database}/documents:beginTransaction",
- "id": "firestore.projects.databases.documents.beginTransaction",
- "description": "Starts a new transaction.",
- "request": {
- "$ref": "BeginTransactionRequest"
- }
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:batchGet",
+ "path": "v1beta1/{+database}/documents:batchGet",
+ "id": "firestore.projects.databases.documents.batchGet"
},
"list": {
"description": "Lists documents.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListDocumentsResponse"
},
@@ -1476,7 +1478,6 @@
"parent",
"collectionId"
],
- "httpMethod": "GET",
"parameters": {
"transaction": {
"location": "query",
@@ -1492,15 +1493,15 @@
"location": "path"
},
"orderBy": {
+ "location": "query",
"description": "The order to sort results by. For example: `priority desc, name`.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"readTime": {
+ "location": "query",
"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"
+ "type": "string"
},
"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`.",
@@ -1508,15 +1509,15 @@
"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,
- "location": "query"
+ "repeated": true
},
"pageToken": {
- "location": "query",
"description": "The `next_page_token` value returned from a previous List request, if any.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"collectionId": {
"location": "path",
@@ -1525,10 +1526,10 @@
"type": "string"
},
"pageSize": {
- "location": "query",
"description": "The maximum number of documents to return.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
}
},
"scopes": [
@@ -1536,8 +1537,8 @@
"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"
+ "id": "firestore.projects.databases.documents.list",
+ "path": "v1beta1/{+parent}/{collectionId}"
},
"runQuery": {
"id": "firestore.projects.databases.documents.runQuery",
@@ -1569,10 +1570,6 @@
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runQuery"
},
"createDocument": {
- "request": {
- "$ref": "Document"
- },
- "description": "Creates a new document.",
"response": {
"$ref": "Document"
},
@@ -1581,6 +1578,10 @@
"collectionId"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
"parameters": {
"mask.fieldPaths": {
"description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
@@ -1589,10 +1590,10 @@
"location": "query"
},
"collectionId": {
+ "location": "path",
"description": "The collection ID, relative to `parent`, to list. For example: `chatrooms`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"parent": {
"location": "path",
@@ -1607,111 +1608,21 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{collectionId}",
"path": "v1beta1/{+parent}/{collectionId}",
- "id": "firestore.projects.databases.documents.createDocument"
- },
- "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": {
- "location": "query",
- "description": "Reads the version of the document at the given time.\nThis may not be older than 60 seconds.",
- "format": "google-datetime",
- "type": "string"
- },
- "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}",
- "path": "v1beta1/{+name}",
- "id": "firestore.projects.databases.documents.get"
- },
- "patch": {
- "description": "Updates or inserts a document.",
+ "id": "firestore.projects.databases.documents.createDocument",
+ "description": "Creates a new document.",
"request": {
"$ref": "Document"
- },
- "response": {
- "$ref": "Document"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/datastore"
- ],
- "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": {
- "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": {
- "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": {
- "location": "query",
- "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.",
- "type": "string",
- "repeated": true
- },
- "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
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
- "path": "v1beta1/{+name}",
- "id": "firestore.projects.databases.documents.patch"
+ }
},
"listen": {
+ "id": "firestore.projects.databases.documents.listen",
+ "path": "v1beta1/{+database}/documents:listen",
+ "request": {
+ "$ref": "ListenRequest"
+ },
+ "description": "Listens to changes.",
"httpMethod": "POST",
"parameterOrder": [
"database"
@@ -1732,19 +1643,109 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
- "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:listen",
- "id": "firestore.projects.databases.documents.listen",
- "path": "v1beta1/{+database}/documents:listen",
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:listen"
+ },
+ "patch": {
+ "description": "Updates or inserts a document.",
"request": {
- "$ref": "ListenRequest"
+ "$ref": "Document"
},
- "description": "Listens to changes."
+ "response": {
+ "$ref": "Document"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
+ "parameters": {
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
+ "path": "v1beta1/{+name}",
+ "id": "firestore.projects.databases.documents.patch"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Document"
+ },
+ "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": {
+ "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"
+ },
+ "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}",
+ "id": "firestore.projects.databases.documents.get",
+ "path": "v1beta1/{+name}",
+ "description": "Gets a single document."
},
"listCollectionIds": {
+ "description": "Lists all the collection IDs underneath a document.",
"request": {
"$ref": "ListCollectionIdsRequest"
},
- "description": "Lists all the collection IDs underneath a document.",
"response": {
"$ref": "ListCollectionIdsResponse"
},
@@ -1752,33 +1753,45 @@
"parent"
],
"httpMethod": "POST",
- "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"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
],
+ "parameters": {
+ "parent": {
+ "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",
+ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$"
+ }
+ },
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:listCollectionIds",
"path": "v1beta1/{+parent}:listCollectionIds",
"id": "firestore.projects.databases.documents.listCollectionIds"
},
"delete": {
+ "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}",
+ "path": "v1beta1/{+name}",
+ "id": "firestore.projects.databases.documents.delete",
"description": "Deletes a document.",
- "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/datastore"
+ ],
"parameters": {
+ "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 to delete. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.",
"required": true,
@@ -1787,59 +1800,43 @@
"location": "path"
},
"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",
- "location": "query"
- },
- "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"
- }
- },
- "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}"
- },
- "commit": {
- "httpMethod": "POST",
- "parameterOrder": [
- "database"
- ],
- "response": {
- "$ref": "CommitResponse"
- },
- "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"
- ],
+ }
+ },
+ "commit": {
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:commit",
- "id": "firestore.projects.databases.documents.commit",
"path": "v1beta1/{+database}/documents:commit",
+ "id": "firestore.projects.databases.documents.commit",
"request": {
"$ref": "CommitRequest"
},
- "description": "Commits a transaction, while optionally updating documents."
+ "description": "Commits a transaction, while optionally updating documents.",
+ "response": {
+ "$ref": "CommitResponse"
+ },
+ "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"
+ ]
},
"rollback": {
- "request": {
- "$ref": "RollbackRequest"
- },
- "description": "Rolls back a transaction.",
"httpMethod": "POST",
"parameterOrder": [
"database"
@@ -1862,7 +1859,11 @@
],
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:rollback",
"id": "firestore.projects.databases.documents.rollback",
- "path": "v1beta1/{+database}/documents:rollback"
+ "path": "v1beta1/{+database}/documents:rollback",
+ "request": {
+ "$ref": "RollbackRequest"
+ },
+ "description": "Rolls back a transaction."
}
}
}
@@ -1872,6 +1873,16 @@
}
},
"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": {
"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.",
@@ -1883,37 +1894,42 @@
"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": {
+ "oauth_token": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "description": "OAuth 2.0 token for the current user.",
"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\").",
+ "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"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
@@ -1927,18 +1943,7 @@
"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",
@@ -1946,23 +1951,18 @@
],
"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"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
}
},
"version": "v1beta1",
"baseUrl": "https://firestore.googleapis.com/",
"servicePath": "",
"description": "",
- "kind": "discovery#restDescription",
- "basePath": ""
+ "kind": "discovery#restDescription"
}
diff --git a/genomics/v1/genomics-api.json b/genomics/v1/genomics-api.json
index 17ba4dd..046e5d2 100644
--- a/genomics/v1/genomics-api.json
+++ b/genomics/v1/genomics-api.json
@@ -1,9 +1,749 @@
{
+ "rootUrl": "https://genomics.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "genomics",
+ "batchPath": "batch",
+ "revision": "20171207",
+ "id": "genomics:v1",
+ "documentationLink": "https://cloud.google.com/genomics",
+ "title": "Genomics API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
+ "datasets": {
+ "methods": {
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v1/datasets/{datasetsId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "genomics.datasets.getIamPolicy",
+ "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)",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ }
+ },
+ "patch": {
+ "path": "v1/datasets/{datasetId}",
+ "id": "genomics.datasets.patch",
+ "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.",
+ "request": {
+ "$ref": "Dataset"
+ },
+ "response": {
+ "$ref": "Dataset"
+ },
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "The ID of the dataset to be updated.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/datasets/{datasetId}"
+ },
+ "undelete": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "response": {
+ "$ref": "Dataset"
+ },
+ "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",
+ "id": "genomics.datasets.undelete",
+ "path": "v1/datasets/{datasetId}: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."
+ },
+ "get": {
+ "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)",
+ "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}"
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v1/datasets/{datasetsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "genomics.datasets.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nSee \u003ca href=\"/iam/docs/managing-policies#testing_permissions\"\u003eTesting\nPermissions\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)",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
+ },
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "datasetId": {
+ "description": "The ID of the dataset to be deleted.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/datasets/{datasetId}",
+ "path": "v1/datasets/{datasetId}",
+ "id": "genomics.datasets.delete"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListDatasetsResponse"
+ },
+ "parameterOrder": [],
+ "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 to return in a single page. If unspecified,\ndefaults to 50. The maximum value is 1024.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "projectId": {
+ "description": "Required. The Google Cloud project ID to list datasets for.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "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)"
+ },
+ "setIamPolicy": {
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "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.",
+ "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}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "genomics.datasets.setIamPolicy"
+ },
+ "create": {
+ "response": {
+ "$ref": "Dataset"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/datasets",
+ "path": "v1/datasets",
+ "id": "genomics.datasets.create",
+ "description": "Creates a new 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)",
+ "request": {
+ "$ref": "Dataset"
+ }
+ }
+ }
+ },
+ "annotations": {
+ "methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Annotation"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/annotations",
+ "id": "genomics.annotations.create",
+ "path": "v1/annotations",
+ "request": {
+ "$ref": "Annotation"
+ },
+ "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."
+ },
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/annotations:batchCreate"
+ },
+ "search": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchAnnotationsResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/annotations/search",
+ "id": "genomics.annotations.search",
+ "path": "v1/annotations/search",
+ "request": {
+ "$ref": "SearchAnnotationsRequest"
+ },
+ "description": "Searches for annotations that match the given criteria. Results are\nordered by genomic coordinate (by reference sequence, then position).\nAnnotations with equivalent genomic coordinates are returned in an\nunspecified order. This order is consistent, such that two queries for the\nsame content (regardless of page size) yield annotations in the same order\nacross their respective streams of paginated responses. Caller must have\nREAD permission for the queried annotation sets."
+ },
+ "get": {
+ "path": "v1/annotations/{annotationId}",
+ "id": "genomics.annotations.get",
+ "description": "Gets an annotation. Caller must have READ permission\nfor the associated annotation set.",
+ "response": {
+ "$ref": "Annotation"
+ },
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "annotationId": {
+ "location": "path",
+ "description": "The ID of the annotation to be retrieved.",
+ "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/annotations/{annotationId}"
+ },
+ "update": {
+ "response": {
+ "$ref": "Annotation"
+ },
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "annotationId": {
+ "description": "The ID of the annotation to be updated.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nvariant,\ntranscript, and\ninfo. If unspecified, all mutable\nfields will be updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/annotations/{annotationId}",
+ "path": "v1/annotations/{annotationId}",
+ "id": "genomics.annotations.update",
+ "description": "Updates an annotation. Caller must have\nWRITE permission for the associated dataset.",
+ "request": {
+ "$ref": "Annotation"
+ }
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "annotationId": {
+ "location": "path",
+ "description": "The ID of the annotation to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/annotations/{annotationId}",
+ "path": "v1/annotations/{annotationId}",
+ "id": "genomics.annotations.delete",
+ "description": "Deletes an annotation. Caller must have WRITE permission for\nthe associated annotation set."
+ }
+ }
+ },
+ "variantsets": {
+ "methods": {
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "variantSetId": {
+ "location": "path",
+ "description": "The ID of the variant set to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/variantsets/{variantSetId}"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "VariantSet"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variantsets",
+ "id": "genomics.variantsets.create",
+ "path": "v1/variantsets",
+ "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."
+ },
+ "export": {
+ "path": "v1/variantsets/{variantSetId}:export",
+ "id": "genomics.variantsets.export",
+ "request": {
+ "$ref": "ExportVariantSetRequest"
+ },
+ "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)",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "variantSetId": {
+ "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",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variantsets/{variantSetId}:export"
+ },
+ "search": {
+ "path": "v1/variantsets/search",
+ "id": "genomics.variantsets.search",
+ "description": "Returns a list of all variant sets matching search criteria.\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\nImplements\n[GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49).",
+ "request": {
+ "$ref": "SearchVariantSetsRequest"
+ },
+ "response": {
+ "$ref": "SearchVariantSetsResponse"
+ },
+ "parameterOrder": [],
+ "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/variantsets/search"
+ },
+ "patch": {
+ "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)",
+ "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"
+ },
+ "variantSetId": {
+ "location": "path",
+ "description": "The ID of the variant to be updated (must already exist).",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variantsets/{variantSetId}",
+ "path": "v1/variantsets/{variantSetId}",
+ "id": "genomics.variantsets.patch"
+ },
+ "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"
+ },
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "variantSetId": {
+ "description": "Required. The ID of the variant set.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/variantsets/{variantSetId}",
+ "path": "v1/variantsets/{variantSetId}",
+ "id": "genomics.variantsets.get"
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "cancel": {
+ "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",
+ "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"
+ }
+ },
+ "list": {
+ "path": "v1/{+name}",
+ "id": "genomics.operations.list",
+ "description": "Lists operations that match the specified filter in the request.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/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": "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."
+ }
+ }
+ },
+ "referencesets": {
+ "methods": {
+ "search": {
+ "response": {
+ "$ref": "SearchReferenceSetsResponse"
+ },
+ "parameterOrder": [],
+ "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/referencesets/search",
+ "path": "v1/referencesets/search",
+ "id": "genomics.referencesets.search",
+ "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)",
+ "request": {
+ "$ref": "SearchReferenceSetsRequest"
+ }
+ },
+ "get": {
+ "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": {
+ "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}"
+ }
+ }
+ },
"callsets": {
"methods": {
+ "create": {
+ "response": {
+ "$ref": "CallSet"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/callsets",
+ "path": "v1/callsets",
+ "id": "genomics.callsets.create",
+ "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)",
+ "request": {
+ "$ref": "CallSet"
+ }
+ },
"delete": {
"response": {
"$ref": "Empty"
@@ -14,10 +754,10 @@
"httpMethod": "DELETE",
"parameters": {
"callSetId": {
+ "location": "path",
"description": "The ID of the call set to be deleted.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -30,13 +770,6 @@
"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)"
},
"search": {
- "flatPath": "v1/callsets/search",
- "path": "v1/callsets/search",
- "id": "genomics.callsets.search",
- "request": {
- "$ref": "SearchCallSetsRequest"
- },
- "description": "Gets a list of call sets matching the criteria.\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)\n\nImplements\n[GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178).",
"response": {
"$ref": "SearchCallSetsResponse"
},
@@ -47,7 +780,14 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
- ]
+ ],
+ "flatPath": "v1/callsets/search",
+ "path": "v1/callsets/search",
+ "id": "genomics.callsets.search",
+ "request": {
+ "$ref": "SearchCallSetsRequest"
+ },
+ "description": "Gets a list of call sets matching the criteria.\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)\n\nImplements\n[GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178)."
},
"patch": {
"request": {
@@ -62,17 +802,17 @@
"$ref": "CallSet"
},
"parameters": {
+ "callSetId": {
+ "location": "path",
+ "description": "The ID of the call set to be updated.",
+ "required": true,
+ "type": "string"
+ },
"updateMask": {
"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",
"location": "query"
- },
- "callSetId": {
- "description": "The ID of the call set to be updated.",
- "required": true,
- "type": "string",
- "location": "path"
}
},
"scopes": [
@@ -84,10 +824,6 @@
"path": "v1/callsets/{callSetId}"
},
"get": {
- "flatPath": "v1/callsets/{callSetId}",
- "path": "v1/callsets/{callSetId}",
- "id": "genomics.callsets.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)",
"response": {
"$ref": "CallSet"
},
@@ -107,26 +843,11 @@
"type": "string",
"location": "path"
}
- }
- },
- "create": {
- "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)",
- "request": {
- "$ref": "CallSet"
},
- "response": {
- "$ref": "CallSet"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/callsets",
- "path": "v1/callsets",
- "id": "genomics.callsets.create"
+ "flatPath": "v1/callsets/{callSetId}",
+ "path": "v1/callsets/{callSetId}",
+ "id": "genomics.callsets.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)"
}
}
},
@@ -155,9 +876,74 @@
}
},
"readgroupsets": {
+ "resources": {
+ "coveragebuckets": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListCoverageBucketsResponse"
+ },
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "httpMethod": "GET",
+ "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"
+ },
+ "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"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. 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. Defaults to 0.",
+ "format": "int64",
+ "type": "string",
+ "location": "query"
+ },
+ "readGroupSetId": {
+ "description": "Required. The ID of the read group set over which coverage is requested.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "targetBucketWidth": {
+ "description": "The desired width of each reported coverage bucket in base pairs. This\nwill be rounded down to the nearest precomputed bucket width; the value\nof which is returned as `bucketWidth` in the response. Defaults\nto infinity (each bucket spans an entire reference sequence) or the length\nof the target range, if specified. The smallest precomputed\n`bucketWidth` is currently 2048 base pairs; this is subject to\nchange.",
+ "format": "int64",
+ "type": "string",
+ "location": "query"
+ },
+ "referenceName": {
+ "location": "query",
+ "description": "The name of the reference to query, within the reference set associated\nwith this query. Optional.",
+ "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/readgroupsets/{readGroupSetId}/coveragebuckets",
+ "path": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
+ "id": "genomics.readgroupsets.coveragebuckets.list",
+ "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."
+ }
+ }
+ }
+ },
"methods": {
"export": {
- "flatPath": "v1/readgroupsets/{readGroupSetId}: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.",
@@ -178,18 +964,15 @@
],
"parameters": {
"readGroupSetId": {
+ "location": "path",
"description": "Required. The ID of the read group set to export. The caller must have\nREAD access to this read group set.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
- }
+ },
+ "flatPath": "v1/readgroupsets/{readGroupSetId}:export"
},
"search": {
- "description": "Searches for read group sets matching the criteria.\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\nImplements\n[GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135).",
- "request": {
- "$ref": "SearchReadGroupSetsRequest"
- },
"response": {
"$ref": "SearchReadGroupSetsResponse"
},
@@ -203,13 +986,13 @@
"parameters": {},
"flatPath": "v1/readgroupsets/search",
"path": "v1/readgroupsets/search",
- "id": "genomics.readgroupsets.search"
+ "id": "genomics.readgroupsets.search",
+ "description": "Searches for read group sets matching the criteria.\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\nImplements\n[GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135).",
+ "request": {
+ "$ref": "SearchReadGroupSetsRequest"
+ }
},
"patch": {
- "description": "Updates 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)\n\nThis method supports patch semantics.",
- "request": {
- "$ref": "ReadGroupSet"
- },
"response": {
"$ref": "ReadGroupSet"
},
@@ -229,15 +1012,19 @@
"location": "path"
},
"updateMask": {
- "location": "query",
"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"
+ "type": "string",
+ "location": "query"
}
},
"flatPath": "v1/readgroupsets/{readGroupSetId}",
"path": "v1/readgroupsets/{readGroupSetId}",
- "id": "genomics.readgroupsets.patch"
+ "id": "genomics.readgroupsets.patch",
+ "description": "Updates 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)\n\nThis method supports patch semantics.",
+ "request": {
+ "$ref": "ReadGroupSet"
+ }
},
"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)",
@@ -250,10 +1037,10 @@
],
"parameters": {
"readGroupSetId": {
+ "location": "path",
"description": "The ID of the read group set.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -266,7 +1053,6 @@
"path": "v1/readgroupsets/{readGroupSetId}"
},
"import": {
- "flatPath": "v1/readgroupsets:import",
"path": "v1/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)",
@@ -283,13 +1069,10 @@
"https://www.googleapis.com/auth/devstorage.read_write",
"https://www.googleapis.com/auth/genomics"
],
- "parameters": {}
+ "parameters": {},
+ "flatPath": "v1/readgroupsets:import"
},
"delete": {
- "flatPath": "v1/readgroupsets/{readGroupSetId}",
- "id": "genomics.readgroupsets.delete",
- "path": "v1/readgroupsets/{readGroupSetId}",
- "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)",
"httpMethod": "DELETE",
"response": {
"$ref": "Empty"
@@ -299,89 +1082,51 @@
],
"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"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
- ]
- }
- },
- "resources": {
- "coveragebuckets": {
- "methods": {
- "list": {
- "flatPath": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
- "path": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
- "id": "genomics.readgroupsets.coveragebuckets.list",
- "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.",
- "response": {
- "$ref": "ListCoverageBucketsResponse"
- },
- "parameterOrder": [
- "readGroupSetId"
- ],
- "httpMethod": "GET",
- "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"
- },
- "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 to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 2048.",
- "format": "int32",
- "type": "integer"
- },
- "start": {
- "location": "query",
- "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified. Defaults to 0.",
- "format": "int64",
- "type": "string"
- },
- "readGroupSetId": {
- "description": "Required. The ID of the read group set over which coverage is requested.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "targetBucketWidth": {
- "location": "query",
- "description": "The desired width of each reported coverage bucket in base pairs. This\nwill be rounded down to the nearest precomputed bucket width; the value\nof which is returned as `bucketWidth` in the response. Defaults\nto infinity (each bucket spans an entire reference sequence) or the length\nof the target range, if specified. The smallest precomputed\n`bucketWidth` is currently 2048 base pairs; this is subject to\nchange.",
- "format": "int64",
- "type": "string"
- },
- "referenceName": {
- "description": "The name of the reference to query, within the reference set associated\nwith this query. Optional.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ]
- }
- }
+ ],
+ "flatPath": "v1/readgroupsets/{readGroupSetId}",
+ "id": "genomics.readgroupsets.delete",
+ "path": "v1/readgroupsets/{readGroupSetId}",
+ "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)"
}
}
},
"annotationsets": {
"methods": {
+ "delete": {
+ "description": "Deletes an annotation set. Caller must have WRITE permission\nfor the associated annotation set.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "annotationSetId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "annotationSetId": {
+ "location": "path",
+ "description": "The ID of the annotation set to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/annotationsets/{annotationSetId}",
+ "path": "v1/annotationsets/{annotationSetId}",
+ "id": "genomics.annotationsets.delete"
+ },
"search": {
- "flatPath": "v1/annotationsets/search",
"id": "genomics.annotationsets.search",
"path": "v1/annotationsets/search",
"request": {
@@ -398,7 +1143,8 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
- ]
+ ],
+ "flatPath": "v1/annotationsets/search"
},
"get": {
"response": {
@@ -439,17 +1185,17 @@
],
"httpMethod": "PUT",
"parameters": {
- "updateMask": {
- "location": "query",
- "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nsource_uri, and\ninfo. If unspecified, all\nmutable fields will be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
"annotationSetId": {
"description": "The ID of the annotation set to be updated.",
"required": true,
"type": "string",
"location": "path"
+ },
+ "updateMask": {
+ "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nsource_uri, and\ninfo. If unspecified, all\nmutable fields will be updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
@@ -461,6 +1207,12 @@
"id": "genomics.annotationsets.update"
},
"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"
},
@@ -471,48 +1223,13 @@
"https://www.googleapis.com/auth/genomics"
],
"parameters": {},
- "flatPath": "v1/annotationsets",
- "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"
- }
- },
- "delete": {
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "annotationSetId": {
- "description": "The ID of the annotation set to be deleted.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
+ "flatPath": "v1/annotationsets"
}
}
},
"variants": {
"methods": {
"create": {
- "description": "Creates a new 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)",
- "request": {
- "$ref": "Variant"
- },
"response": {
"$ref": "Variant"
},
@@ -525,13 +1242,13 @@
"parameters": {},
"flatPath": "v1/variants",
"path": "v1/variants",
- "id": "genomics.variants.create"
+ "id": "genomics.variants.create",
+ "description": "Creates a new 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)",
+ "request": {
+ "$ref": "Variant"
+ }
},
"search": {
- "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).",
- "request": {
- "$ref": "SearchVariantsRequest"
- },
"response": {
"$ref": "SearchVariantsResponse"
},
@@ -545,9 +1262,16 @@
"parameters": {},
"flatPath": "v1/variants/search",
"path": "v1/variants/search",
- "id": "genomics.variants.search"
+ "id": "genomics.variants.search",
+ "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).",
+ "request": {
+ "$ref": "SearchVariantsRequest"
+ }
},
"get": {
+ "path": "v1/variants/{variantId}",
+ "id": "genomics.variants.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)",
"response": {
"$ref": "Variant"
},
@@ -568,10 +1292,7 @@
"https://www.googleapis.com/auth/genomics",
"https://www.googleapis.com/auth/genomics.readonly"
],
- "flatPath": "v1/variants/{variantId}",
- "path": "v1/variants/{variantId}",
- "id": "genomics.variants.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)"
+ "flatPath": "v1/variants/{variantId}"
},
"patch": {
"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.",
@@ -608,7 +1329,6 @@
"id": "genomics.variants.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)",
"response": {
"$ref": "Empty"
},
@@ -622,24 +1342,18 @@
],
"parameters": {
"variantId": {
- "location": "path",
"description": "The ID of the variant to be deleted.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"flatPath": "v1/variants/{variantId}",
"path": "v1/variants/{variantId}",
- "id": "genomics.variants.delete"
+ "id": "genomics.variants.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)"
},
"import": {
- "flatPath": "v1/variants:import",
- "id": "genomics.variants.import",
- "path": "v1/variants:import",
- "request": {
- "$ref": "ImportVariantsRequest"
- },
- "description": "Creates variant data by asynchronously importing the provided information.\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 variants for import will be merged with any existing variant that\nmatches its reference sequence, start, end, reference bases, and\nalternative bases. If no such variant exists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant, and Variant info fields are merged\nas specified in\ninfoMergeConfig.\nAs a special case, for single-sample VCF files, QUAL and FILTER fields will\nbe moved to the call level; these are sometimes interpreted in a\ncall-specific context.\nImported VCF headers are appended to the metadata already in a variant set.",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
@@ -650,16 +1364,16 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/devstorage.read_write",
"https://www.googleapis.com/auth/genomics"
- ]
+ ],
+ "flatPath": "v1/variants:import",
+ "id": "genomics.variants.import",
+ "path": "v1/variants:import",
+ "request": {
+ "$ref": "ImportVariantsRequest"
+ },
+ "description": "Creates variant data by asynchronously importing the provided information.\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 variants for import will be merged with any existing variant that\nmatches its reference sequence, start, end, reference bases, and\nalternative bases. If no such variant exists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant, and Variant info fields are merged\nas specified in\ninfoMergeConfig.\nAs a special case, for single-sample VCF files, QUAL and FILTER fields will\nbe moved to the call level; these are sometimes interpreted in a\ncall-specific context.\nImported VCF headers are appended to the metadata already in a variant set."
},
"merge": {
- "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"
- },
"response": {
"$ref": "Empty"
},
@@ -669,17 +1383,75 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
- "parameters": {}
+ "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"
+ }
}
}
},
"references": {
+ "resources": {
+ "bases": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListBasesResponse"
+ },
+ "parameterOrder": [
+ "referenceId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "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": {
+ "description": "The maximum number of bases to return in a single page. If unspecified,\ndefaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base\npairs).",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "start": {
+ "description": "The start position (0-based) of this query. Defaults to 0.",
+ "format": "int64",
+ "type": "string",
+ "location": "query"
+ },
+ "referenceId": {
+ "location": "path",
+ "description": "The ID of the reference.",
+ "required": true,
+ "type": "string"
+ },
+ "end": {
+ "description": "The end position (0-based, exclusive) of this query. Defaults to the length\nof this reference.",
+ "format": "int64",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "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)."
+ }
+ }
+ }
+ },
"methods": {
"search": {
- "request": {
- "$ref": "SearchReferencesRequest"
- },
- "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).",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
@@ -693,7 +1465,11 @@
],
"flatPath": "v1/references/search",
"id": "genomics.references.search",
- "path": "v1/references/search"
+ "path": "v1/references/search",
+ "request": {
+ "$ref": "SearchReferencesRequest"
+ },
+ "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)."
},
"get": {
"description": "Gets a reference.\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.getReference](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L158).",
@@ -721,832 +1497,10 @@
"path": "v1/references/{referenceId}",
"id": "genomics.references.get"
}
- },
- "resources": {
- "bases": {
- "methods": {
- "list": {
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "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"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of bases to return in a single page. If unspecified,\ndefaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base\npairs).",
- "format": "int32",
- "type": "integer"
- },
- "start": {
- "description": "The start position (0-based) of this query. Defaults to 0.",
- "format": "int64",
- "type": "string",
- "location": "query"
- },
- "referenceId": {
- "location": "path",
- "description": "The ID of the reference.",
- "required": true,
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "datasets": {
- "methods": {
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "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"
- }
- },
- "flatPath": "v1/datasets/{datasetsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "genomics.datasets.testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nSee \u003ca href=\"/iam/docs/managing-policies#testing_permissions\"\u003eTesting\nPermissions\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)",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- }
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "datasetId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "datasetId": {
- "location": "path",
- "description": "The ID of the dataset to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "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)"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListDatasetsResponse"
- },
- "parameterOrder": [],
- "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"
- },
- "pageSize": {
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 50. The maximum value is 1024.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "projectId": {
- "location": "query",
- "description": "Required. The Google Cloud project ID to list datasets for.",
- "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/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)"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^datasets/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets/{datasetsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "genomics.datasets.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "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."
- },
- "create": {
- "description": "Creates a new 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)",
- "request": {
- "$ref": "Dataset"
- },
- "response": {
- "$ref": "Dataset"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/datasets",
- "path": "v1/datasets",
- "id": "genomics.datasets.create"
- },
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "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"
- }
- },
- "flatPath": "v1/datasets/{datasetsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "genomics.datasets.getIamPolicy",
- "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)",
- "request": {
- "$ref": "GetIamPolicyRequest"
- }
- },
- "patch": {
- "response": {
- "$ref": "Dataset"
- },
- "parameterOrder": [
- "datasetId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "datasetId": {
- "description": "The ID of the dataset to be updated.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "updateMask": {
- "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",
- "location": "query"
- }
- },
- "flatPath": "v1/datasets/{datasetId}",
- "path": "v1/datasets/{datasetId}",
- "id": "genomics.datasets.patch",
- "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.",
- "request": {
- "$ref": "Dataset"
- }
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "datasetId"
- ],
- "response": {
- "$ref": "Dataset"
- },
- "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",
- "id": "genomics.datasets.undelete",
- "path": "v1/datasets/{datasetId}:undelete"
- },
- "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)"
- }
- }
- },
- "annotations": {
- "methods": {
- "create": {
- "request": {
- "$ref": "Annotation"
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Annotation"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/annotations",
- "id": "genomics.annotations.create",
- "path": "v1/annotations"
- },
- "batchCreate": {
- "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",
- "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"
- }
- },
- "search": {
- "request": {
- "$ref": "SearchAnnotationsRequest"
- },
- "description": "Searches for annotations that match the given criteria. Results are\nordered by genomic coordinate (by reference sequence, then position).\nAnnotations with equivalent genomic coordinates are returned in an\nunspecified order. This order is consistent, such that two queries for the\nsame content (regardless of page size) yield annotations in the same order\nacross their respective streams of paginated responses. Caller must have\nREAD permission for the queried annotation sets.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchAnnotationsResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/annotations/search",
- "id": "genomics.annotations.search",
- "path": "v1/annotations/search"
- },
- "get": {
- "response": {
- "$ref": "Annotation"
- },
- "parameterOrder": [
- "annotationId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "annotationId": {
- "location": "path",
- "description": "The ID of the annotation to be retrieved.",
- "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/annotations/{annotationId}",
- "path": "v1/annotations/{annotationId}",
- "id": "genomics.annotations.get",
- "description": "Gets an annotation. Caller must have READ permission\nfor the associated annotation set."
- },
- "update": {
- "flatPath": "v1/annotations/{annotationId}",
- "path": "v1/annotations/{annotationId}",
- "id": "genomics.annotations.update",
- "description": "Updates an annotation. Caller must have\nWRITE permission for the associated dataset.",
- "request": {
- "$ref": "Annotation"
- },
- "response": {
- "$ref": "Annotation"
- },
- "parameterOrder": [
- "annotationId"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nvariant,\ntranscript, and\ninfo. If unspecified, all mutable\nfields will be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "annotationId": {
- "description": "The ID of the annotation to be updated.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
- },
- "delete": {
- "description": "Deletes an annotation. Caller must have WRITE permission for\nthe associated annotation set.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "annotationId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "annotationId": {
- "description": "The ID of the annotation to be deleted.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/annotations/{annotationId}",
- "path": "v1/annotations/{annotationId}",
- "id": "genomics.annotations.delete"
- }
- }
- },
- "variantsets": {
- "methods": {
- "export": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "variantSetId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "variantSetId": {
- "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",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/variantsets/{variantSetId}:export",
- "path": "v1/variantsets/{variantSetId}:export",
- "id": "genomics.variantsets.export",
- "request": {
- "$ref": "ExportVariantSetRequest"
- },
- "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": {
- "flatPath": "v1/variantsets/search",
- "path": "v1/variantsets/search",
- "id": "genomics.variantsets.search",
- "description": "Returns a list of all variant sets matching search criteria.\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\nImplements\n[GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49).",
- "request": {
- "$ref": "SearchVariantSetsRequest"
- },
- "response": {
- "$ref": "SearchVariantSetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {}
- },
- "patch": {
- "flatPath": "v1/variantsets/{variantSetId}",
- "path": "v1/variantsets/{variantSetId}",
- "id": "genomics.variantsets.patch",
- "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)",
- "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"
- },
- "variantSetId": {
- "description": "The ID of the variant to be updated (must already exist).",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ]
- },
- "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"
- },
- "parameterOrder": [
- "variantSetId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "variantSetId": {
- "description": "Required. The ID of the variant set.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/variantsets/{variantSetId}",
- "path": "v1/variantsets/{variantSetId}",
- "id": "genomics.variantsets.get"
- },
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "variantSetId": {
- "location": "path",
- "description": "The ID of the variant set to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/variantsets/{variantSetId}",
- "path": "v1/variantsets/{variantSetId}",
- "id": "genomics.variantsets.delete"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "VariantSet"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/variantsets",
- "id": "genomics.variantsets.create",
- "path": "v1/variantsets",
- "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."
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "description": "Lists operations that match the specified filter in the request.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/operations",
- "path": "v1/{+name}",
- "id": "genomics.operations.list"
- },
- "get": {
- "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",
- "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.",
- "required": true,
- "type": "string",
- "pattern": "^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/.+$"
- }
- },
- "flatPath": "v1/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "genomics.operations.cancel"
- }
- }
- },
- "referencesets": {
- "methods": {
- "search": {
- "flatPath": "v1/referencesets/search",
- "path": "v1/referencesets/search",
- "id": "genomics.referencesets.search",
- "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)",
- "request": {
- "$ref": "SearchReferenceSetsRequest"
- },
- "response": {
- "$ref": "SearchReferenceSetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {}
- },
- "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"
- }
}
}
},
"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": {
- "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",
@@ -1569,28 +1523,156 @@
"default": "true"
},
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "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"
+ },
+ "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": {
+ "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"
}
},
"schemas": {
+ "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": {
+ "description": "The call set search request.",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "SearchCallSetsRequest"
+ },
+ "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": {
+ "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"
+ ],
+ "description": "The partition strategy describes how read groups are partitioned into read\ngroup sets.",
+ "type": "string"
+ },
+ "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"
+ }
+ }
+ },
+ "id": "ImportReadGroupSetsRequest"
+ },
"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": {
- "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",
@@ -1600,6 +1682,13 @@
"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"
@@ -1608,6 +1697,22 @@
"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",
@@ -1628,43 +1733,23 @@
"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"
}
},
"id": "SearchReadsRequest"
},
"CancelOperationRequest": {
- "description": "The request message for Operations.CancelOperation.",
- "type": "object",
"properties": {},
- "id": "CancelOperationRequest"
+ "id": "CancelOperationRequest",
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object"
},
"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": {
"referenceName": {
"description": "The display name corresponding to the reference specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.",
"type": "string"
},
"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.",
@@ -1678,17 +1763,19 @@
"VARIANT",
"GENE",
"TRANSCRIPT"
- ]
+ ],
+ "description": "The data type for this annotation. Must match the containing annotation\nset's type.",
+ "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"
},
"end": {
"description": "The end position of the range on the reference, 0-based exclusive.",
@@ -1729,15 +1816,17 @@
"type": "boolean"
}
},
- "id": "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"
},
"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."
+ "description": "Execution information specific to Google Compute Engine.",
+ "$ref": "ComputeEngine"
}
},
"id": "RuntimeMetadata"
@@ -1751,20 +1840,20 @@
"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"
- }
+ },
+ "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"
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
@@ -1795,6 +1884,10 @@
"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": {
+ "callSetName": {
+ "description": "The name of the call set this variant call belongs to.",
+ "type": "string"
+ },
"genotypeLikelihood": {
"description": "The genotype likelihoods for this variant call. Each array entry\nrepresents how likely a specific genotype is for this call. The value\nordering is defined by the GL tag in the VCF spec.\nIf Phred-scaled genotype likelihood scores (PL) are available and\nlog10(P) genotype likelihood scores (GL) are not, PL scores are converted\nto GL scores. If both are available, PL scores are stored in `info`.",
"type": "array",
@@ -1820,18 +1913,14 @@
"type": "string"
},
"info": {
- "description": "A map of additional variant call 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"
}
- }
- },
- "callSetName": {
- "description": "The name of the call set this variant call belongs to.",
- "type": "string"
+ },
+ "description": "A map of additional variant call information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object"
}
},
"id": "VariantCall"
@@ -1855,7 +1944,6 @@
"id": "SearchVariantsResponse"
},
"ListBasesResponse": {
- "type": "object",
"properties": {
"sequence": {
"description": "A substring of the bases that make up this reference.",
@@ -1871,7 +1959,8 @@
"type": "string"
}
},
- "id": "ListBasesResponse"
+ "id": "ListBasesResponse",
+ "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.",
@@ -1881,11 +1970,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"
}
},
"code": {
@@ -1901,9 +1990,9 @@
"id": "Status"
},
"UndeleteDatasetRequest": {
- "type": "object",
"properties": {},
- "id": "UndeleteDatasetRequest"
+ "id": "UndeleteDatasetRequest",
+ "type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
@@ -1927,6 +2016,10 @@
"description": "A 0-based half-open genomic coordinate range for search requests.",
"type": "object",
"properties": {
+ "referenceName": {
+ "description": "The reference sequence name, for example `chr1`,\n`1`, or `chrX`.",
+ "type": "string"
+ },
"start": {
"description": "The start position of the range on the reference, 0-based inclusive.",
"format": "int64",
@@ -1936,17 +2029,11 @@
"description": "The end position of the range on the reference, 0-based exclusive.",
"format": "int64",
"type": "string"
- },
- "referenceName": {
- "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)",
- "type": "object",
"properties": {
"description": {
"description": "A textual description of this variant set.",
@@ -1983,7 +2070,9 @@
"type": "string"
}
},
- "id": "VariantSet"
+ "id": "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)",
+ "type": "object"
},
"BatchCreateAnnotationsResponse": {
"type": "object",
@@ -2015,8 +2104,6 @@
"id": "ReferenceBound"
},
"ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -2030,31 +2117,12 @@
}
}
},
- "id": "ListOperationsResponse"
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
},
"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": {
- "created": {
- "description": "The date this variant was created, in milliseconds from the epoch.",
- "format": "int64",
- "type": "string"
- },
- "start": {
- "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"
@@ -2064,14 +2132,14 @@
"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",
"additionalProperties": {
"type": "array",
"items": {
"type": "any"
}
- }
+ },
+ "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"
},
"referenceBases": {
"description": "The reference bases for this variant. They start at the given\nposition.",
@@ -2109,44 +2177,51 @@
"items": {
"$ref": "VariantCall"
}
+ },
+ "created": {
+ "description": "The date this variant was created, in milliseconds from the epoch.",
+ "format": "int64",
+ "type": "string"
+ },
+ "start": {
+ "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"
}
},
- "id": "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"
},
"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"
}
},
"id": "SearchCallSetsResponse"
},
"SearchVariantsRequest": {
- "description": "The variant search request.",
- "type": "object",
"properties": {
- "variantSetIds": {
- "description": "At most one variant set ID must be provided. Only variants from this\nvariant set will be returned. If omitted, a call set id must be included in\nthe request.",
- "type": "array",
- "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"
- },
"maxCalls": {
"description": "The maximum number of calls to return in a single page. Note that this\nlimit may be exceeded in the event that a matching variant contains more\ncalls than the requested maximum. If unspecified, defaults to 5000. The\nmaximum value is 10000.",
"format": "int32",
@@ -2180,39 +2255,26 @@
"referenceName": {
"description": "Required. Only return variants in this reference sequence.",
"type": "string"
- }
- },
- "id": "SearchVariantsRequest"
- },
- "OperationMetadata": {
- "description": "Metadata describing an Operation.",
- "type": "object",
- "properties": {
- "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.",
+ },
+ "variantSetIds": {
+ "description": "At most one variant set ID must be provided. Only variants from this\nvariant set will be returned. If omitted, a call set id must be included in\nthe request.",
"type": "array",
"items": {
- "$ref": "OperationEvent"
+ "type": "string"
}
},
- "endTime": {
- "description": "The time at which the job stopped running.",
- "format": "google-datetime",
+ "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"
- },
- "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"
- }
- },
+ }
+ },
+ "id": "SearchVariantsRequest",
+ "description": "The variant search request.",
+ "type": "object"
+ },
+ "OperationMetadata": {
+ "properties": {
"runtimeMetadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -2240,14 +2302,46 @@
"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": {
+ "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"
}
},
- "id": "OperationMetadata"
+ "id": "OperationMetadata",
+ "description": "Metadata describing an Operation.",
+ "type": "object"
},
"SearchReadGroupSetsRequest": {
- "description": "The read group set search request.",
- "type": "object",
"properties": {
+ "datasetIds": {
+ "description": "Restricts this query to read group sets within the given datasets. At least\none ID must be provided.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"name": {
"description": "Only return read group sets for which a substring of the name matches this\nstring.",
"type": "string"
@@ -2260,33 +2354,28 @@
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 1024.",
"format": "int32",
"type": "integer"
- },
- "datasetIds": {
- "description": "Restricts this query to read group sets within the given datasets. At least\none ID must be provided.",
- "type": "array",
- "items": {
- "type": "string"
- }
}
},
- "id": "SearchReadGroupSetsRequest"
+ "id": "SearchReadGroupSetsRequest",
+ "description": "The read group set search request.",
+ "type": "object"
},
"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"
+ "id": "SearchAnnotationsResponse",
+ "type": "object"
},
"ClinicalCondition": {
"type": "object",
@@ -2317,8 +2406,6 @@
"id": "ClinicalCondition"
},
"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.",
@@ -2332,10 +2419,11 @@
}
}
},
- "id": "SearchReadsResponse"
+ "id": "SearchReadsResponse",
+ "description": "The read search response.",
+ "type": "object"
},
"Program": {
- "type": "object",
"properties": {
"name": {
"description": "The display name of the program. This is typically the colloquial name of\nthe tool used, for example 'bwa' or 'picard'.",
@@ -2358,16 +2446,11 @@
"type": "string"
}
},
- "id": "Program"
+ "id": "Program",
+ "type": "object"
},
"ComputeEngine": {
- "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"
@@ -2382,13 +2465,17 @@
"items": {
"type": "string"
}
+ },
+ "instanceName": {
+ "description": "The instance on which the operation is running.",
+ "type": "string"
}
},
- "id": "ComputeEngine"
+ "id": "ComputeEngine",
+ "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
+ "type": "object"
},
"CoverageBucket": {
- "description": "A bucket over which read coverage has been precomputed. A bucket corresponds\nto a specific range of the reference sequence.",
- "type": "object",
"properties": {
"meanCoverage": {
"description": "The average number of reads which are aligned to each individual\nreference base in this bucket.",
@@ -2396,22 +2483,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."
}
},
- "id": "CoverageBucket"
+ "id": "CoverageBucket",
+ "description": "A bucket over which read coverage has been precomputed. A bucket corresponds\nto a specific range of the reference sequence.",
+ "type": "object"
},
"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"
@@ -2420,11 +2509,6 @@
"description": "The search variant sets request.",
"type": "object",
"properties": {
- "pageSize": {
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
- "format": "int32",
- "type": "integer"
- },
"datasetIds": {
"description": "Exactly one dataset ID must be provided here. Only variant sets which\nbelong to this dataset will be returned.",
"type": "array",
@@ -2435,13 +2519,16 @@
"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"
}
},
"id": "SearchVariantSetsRequest"
},
"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": {
"info": {
"additionalProperties": {
@@ -2454,6 +2541,14 @@
"type": "object"
},
"type": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "INTEGER",
+ "FLOAT",
+ "FLAG",
+ "CHARACTER",
+ "STRING"
+ ],
"description": "The type of data. Possible types include: Integer, Float,\nFlag, Character, and String.",
"type": "string",
"enumDescriptions": [
@@ -2463,14 +2558,6 @@
"",
"",
""
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "INTEGER",
- "FLOAT",
- "FLAG",
- "CHARACTER",
- "STRING"
]
},
"value": {
@@ -2494,19 +2581,12 @@
"type": "string"
}
},
- "id": "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"
},
"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)",
- "type": "object",
"properties": {
- "sourceAccessions": {
- "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `GCF_000001405.26`.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"ncbiTaxonId": {
"description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.",
"format": "int32",
@@ -2532,13 +2612,32 @@
"description": "The length of this reference's sequence.",
"format": "int64",
"type": "string"
+ },
+ "sourceAccessions": {
+ "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `GCF_000001405.26`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
- "id": "Reference"
+ "id": "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)",
+ "type": "object"
},
"SearchReferenceSetsRequest": {
- "type": "object",
"properties": {
+ "accessions": {
+ "description": "If present, return reference sets for which a prefix of any of\nsourceAccessions\nmatch any of these strings. Accession numbers typically have a main number\nand a version, for example `NC_000001.11`.",
+ "type": "array",
+ "items": {
+ "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. The maximum value is 4096.",
"format": "int32",
@@ -2554,34 +2653,23 @@
"items": {
"type": "string"
}
- },
- "accessions": {
- "description": "If present, return reference sets for which a prefix of any of\nsourceAccessions\nmatch any of these strings. Accession numbers typically have a main number\nand a version, for example `NC_000001.11`.",
- "type": "array",
- "items": {
- "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"
}
},
- "id": "SearchReferenceSetsRequest"
+ "id": "SearchReferenceSetsRequest",
+ "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."
+ "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"
},
"MergeVariantsRequest": {
- "type": "object",
"properties": {
"variants": {
"description": "The variants to be merged with existing variants.",
@@ -2607,29 +2695,34 @@
"type": "string"
}
},
- "id": "MergeVariantsRequest"
+ "id": "MergeVariantsRequest",
+ "type": "object"
},
"BatchCreateAnnotationsRequest": {
- "type": "object",
"properties": {
+ "requestId": {
+ "description": "A unique request ID which enables the server to detect duplicated requests.\nIf provided, duplicated requests will result in the same response; if not\nprovided, duplicated requests may result in duplicated data. For a given\nannotation set, callers should not reuse `request_id`s when writing\ndifferent batches of annotations - behavior in this case is undefined.\nA common approach is to use a UUID. For batch jobs where worker crashes are\na possibility, consider using some unique variant of a worker or run ID.",
+ "type": "string"
+ },
"annotations": {
"description": "The annotations to be created. At most 4096 can be specified in a single\nrequest.",
"type": "array",
"items": {
"$ref": "Annotation"
}
- },
- "requestId": {
- "description": "A unique request ID which enables the server to detect duplicated requests.\nIf provided, duplicated requests will result in the same response; if not\nprovided, duplicated requests may result in duplicated data. For a given\nannotation set, callers should not reuse `request_id`s when writing\ndifferent batches of annotations - behavior in this case is undefined.\nA common approach is to use a UUID. For batch jobs where worker crashes are\na possibility, consider using some unique variant of a worker or run ID.",
- "type": "string"
}
},
- "id": "BatchCreateAnnotationsRequest"
+ "id": "BatchCreateAnnotationsRequest",
+ "type": "object"
},
"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": {
+ "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"
@@ -2648,8 +2741,8 @@
"type": "string"
},
"nextMatePosition": {
- "description": "The mapping of the primary alignment of the\n`(readNumber+1)%numberReads` read in the fragment. It replaces\nmate position and mate strand in SAM.",
- "$ref": "Position"
+ "$ref": "Position",
+ "description": "The mapping of the primary alignment of the\n`(readNumber+1)%numberReads` read in the fragment. It replaces\nmate position and mate strand in SAM."
},
"info": {
"additionalProperties": {
@@ -2687,8 +2780,8 @@
}
},
"alignment": {
- "$ref": "LinearAlignment",
- "description": "The linear alignment for this alignment record. This field is null for\nunmapped reads."
+ "description": "The linear alignment for this alignment record. This field is null for\nunmapped reads.",
+ "$ref": "LinearAlignment"
},
"numberReads": {
"description": "The number of reads in the fragment (extension to SAM flag 0x1).",
@@ -2706,17 +2799,11 @@
"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"
}
},
"id": "Read"
},
"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`.",
@@ -2758,23 +2845,18 @@
"type": "string"
}
},
- "id": "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"
},
"CigarUnit": {
- "description": "A single CIGAR operation.",
- "type": "object",
"properties": {
- "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.",
- "type": "string"
- },
"operationLength": {
"description": "The number of genomic bases that the operation runs for. Required.",
"format": "int64",
"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`.",
@@ -2798,47 +2880,20 @@
"PAD",
"SEQUENCE_MATCH",
"SEQUENCE_MISMATCH"
- ]
- }
- },
- "id": "CigarUnit"
- },
- "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": {
- "referenceSetId": {
- "description": "The ID of the reference set that defines the coordinate space for this\nset's annotations.",
+ ],
"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.",
- "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"
- ]
- },
- "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"
- },
+ "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.",
+ "type": "string"
+ }
+ },
+ "id": "CigarUnit",
+ "description": "A single CIGAR operation.",
+ "type": "object"
+ },
+ "AnnotationSet": {
+ "properties": {
"id": {
"description": "The server-generated annotation set ID, unique across all annotation sets.",
"type": "string"
@@ -2854,28 +2909,62 @@
"name": {
"description": "The display name for this annotation set.",
"type": "string"
+ },
+ "referenceSetId": {
+ "description": "The ID of the reference set that defines the coordinate space for this\nset's annotations.",
+ "type": "string"
+ },
+ "type": {
+ "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"
+ ],
+ "description": "The type of annotations contained within this set.",
+ "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"
}
},
- "id": "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"
},
"Transcript": {
"description": "A transcript represents the assertion that a particular region of the\nreference genome may be transcribed as RNA.",
"type": "object",
"properties": {
+ "codingSequence": {
+ "$ref": "CodingSequence",
+ "description": "The range of the coding sequence for this transcript, if any. To determine\nthe exact ranges of coding sequence, intersect this range with those of the\nexons, if any. If there are any\nexons, the\ncodingSequence must start\nand end within them.\n\nNote that in some cases, the reference genome will not exactly match the\nobserved mRNA transcript e.g. due to variance in the source genome from\nreference. In these cases,\nexon.frame will not necessarily\nmatch the expected reference reading frame and coding exon reference bases\ncannot necessarily be concatenated to produce the original transcript mRNA."
+ },
+ "geneId": {
+ "description": "The annotation ID of the gene from which this transcript is transcribed.",
+ "type": "string"
+ },
"exons": {
"description": "The \u003ca href=\"http://en.wikipedia.org/wiki/Exon\"\u003eexons\u003c/a\u003e that compose\nthis transcript. This field should be unset for genomes where transcript\nsplicing does not occur, for example prokaryotes.\n\nIntrons are regions of the transcript that are not included in the\nspliced RNA product. Though not explicitly modeled here, intron ranges can\nbe deduced; all regions of this transcript that are not exons are introns.\n\nExonic sequences do not necessarily code for a translational product\n(amino acids). Only the regions of exons bounded by the\ncodingSequence correspond\nto coding DNA sequence.\n\nExons are ordered by start position and may not overlap.",
"type": "array",
"items": {
"$ref": "Exon"
}
- },
- "codingSequence": {
- "description": "The range of the coding sequence for this transcript, if any. To determine\nthe exact ranges of coding sequence, intersect this range with those of the\nexons, if any. If there are any\nexons, the\ncodingSequence must start\nand end within them.\n\nNote that in some cases, the reference genome will not exactly match the\nobserved mRNA transcript e.g. due to variance in the source genome from\nreference. In these cases,\nexon.frame will not necessarily\nmatch the expected reference reading frame and coding exon reference bases\ncannot necessarily be concatenated to produce the original transcript mRNA.",
- "$ref": "CodingSequence"
- },
- "geneId": {
- "description": "The annotation ID of the gene from which this transcript is transcribed.",
- "type": "string"
}
},
"id": "Transcript"
@@ -2883,10 +2972,6 @@
"Experiment": {
"type": "object",
"properties": {
- "platformUnit": {
- "description": "The platform unit used as part of this experiment, for example\nflowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the\n@RG PU field in the SAM spec.",
- "type": "string"
- },
"libraryId": {
"description": "A client-supplied library identifier; a library is a collection of DNA\nfragments which have been prepared for sequencing from a sample. This\nfield is important for quality control as error or bias can be introduced\nduring sample preparation.",
"type": "string"
@@ -2898,6 +2983,10 @@
"sequencingCenter": {
"description": "The sequencing center used as part of this experiment.",
"type": "string"
+ },
+ "platformUnit": {
+ "description": "The platform unit used as part of this experiment, for example\nflowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the\n@RG PU field in the SAM spec.",
+ "type": "string"
}
},
"id": "Experiment"
@@ -2921,8 +3010,6 @@
"id": "ListDatasetsResponse"
},
"TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
"properties": {
"permissions": {
"description": "REQUIRED: The set of permissions to check for the 'resource'.\nPermissions with wildcards (such as '*' or 'storage.*') are not allowed.\nAllowed permissions are:\n\n* `genomics.datasets.create`\n* `genomics.datasets.delete`\n* `genomics.datasets.get`\n* `genomics.datasets.list`\n* `genomics.datasets.update`\n* `genomics.datasets.getIamPolicy`\n* `genomics.datasets.setIamPolicy`",
@@ -2932,16 +3019,12 @@
}
}
},
- "id": "TestIamPermissionsRequest"
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object"
},
"ExportReadGroupSetRequest": {
- "description": "The read group set export request.",
- "type": "object",
"properties": {
- "projectId": {
- "description": "Required. The Google Cloud project ID that owns this\nexport. The caller must have WRITE access to this project.",
- "type": "string"
- },
"exportUri": {
"description": "Required. A Google Cloud Storage URI for the exported BAM file.\nThe currently authenticated user must have write access to the new file.\nAn error will be returned if the URI already contains data.",
"type": "string"
@@ -2952,13 +3035,24 @@
"items": {
"type": "string"
}
+ },
+ "projectId": {
+ "description": "Required. The Google Cloud project ID that owns this\nexport. The caller must have WRITE access to this project.",
+ "type": "string"
}
},
- "id": "ExportReadGroupSetRequest"
+ "id": "ExportReadGroupSetRequest",
+ "description": "The read group set export request.",
+ "type": "object"
},
"Exon": {
"type": "object",
"properties": {
+ "start": {
+ "description": "The start position of the exon on this annotation's reference sequence,\n0-based inclusive. Note that this is relative to the reference start, and\n**not** the containing annotation start.",
+ "format": "int64",
+ "type": "string"
+ },
"end": {
"description": "The end position of the exon on this annotation's reference sequence,\n0-based exclusive. Note that this is relative to the reference start, and\n*not* the containing annotation start.",
"format": "int64",
@@ -2968,11 +3062,6 @@
"description": "The frame of this exon. Contains a value of 0, 1, or 2, which indicates\nthe offset of the first coding base of the exon within the reading frame\nof the coding DNA sequence, if any. This field is dependent on the\nstrandedness of this annotation (see\nAnnotation.reverse_strand).\nFor forward stranded annotations, this offset is relative to the\nexon.start. For reverse\nstrand annotations, this offset is relative to the\nexon.end `- 1`.\n\nUnset if this exon does not intersect the coding sequence. Upon creation\nof a transcript, the frame must be populated for all or none of the\ncoding exons.",
"format": "int32",
"type": "integer"
- },
- "start": {
- "description": "The start position of the exon on this annotation's reference sequence,\n0-based inclusive. Note that this is relative to the reference start, and\n**not** the containing annotation start.",
- "format": "int64",
- "type": "string"
}
},
"id": "Exon"
@@ -2981,6 +3070,10 @@
"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": {
+ "name": {
+ "description": "The call set name.",
+ "type": "string"
+ },
"info": {
"additionalProperties": {
"type": "array",
@@ -3010,16 +3103,11 @@
"sampleId": {
"description": "The sample ID this call set corresponds to.",
"type": "string"
- },
- "name": {
- "description": "The call set name.",
- "type": "string"
}
},
"id": "CallSet"
},
"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.",
@@ -3033,7 +3121,8 @@
}
}
},
- "id": "SearchAnnotationSetsResponse"
+ "id": "SearchAnnotationSetsResponse",
+ "type": "object"
},
"ImportVariantsRequest": {
"description": "The variant data import request.",
@@ -3041,12 +3130,12 @@
"properties": {
"infoMergeConfig": {
"additionalProperties": {
- "type": "string",
"enum": [
"INFO_MERGE_OPERATION_UNSPECIFIED",
"IGNORE_NEW",
"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"
@@ -3084,7 +3173,6 @@
"id": "ImportVariantsRequest"
},
"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.",
@@ -3103,42 +3191,11 @@
}
}
},
- "id": "ListCoverageBucketsResponse"
+ "id": "ListCoverageBucketsResponse",
+ "type": "object"
},
"VariantAnnotation": {
- "type": "object",
"properties": {
- "transcriptIds": {
- "description": "Google annotation IDs of the transcripts affected by this variant. These\nshould be provided when the variant is created.",
- "type": "array",
- "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"
@@ -3148,22 +3205,6 @@
"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",
@@ -3181,7 +3222,23 @@
"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"
+ "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."
+ ]
},
"conditions": {
"description": "The set of conditions associated with this variant.\nA condition describes the way a variant influences human health.",
@@ -3191,8 +3248,6 @@
}
},
"effect": {
- "description": "Effect of the variant on the coding sequence.",
- "type": "string",
"enumDescriptions": [
"",
"`EFFECT_OTHER` should be used when no other Effect\nwill suffice.",
@@ -3214,25 +3269,57 @@
"STOP_GAIN",
"STOP_LOSS",
"SPLICE_SITE_DISRUPTION"
- ]
+ ],
+ "description": "Effect of the variant on the coding sequence.",
+ "type": "string"
+ },
+ "transcriptIds": {
+ "description": "Google annotation IDs of the transcripts affected by this variant. These\nshould be provided when the variant is created.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "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"
}
},
- "id": "VariantAnnotation"
+ "id": "VariantAnnotation",
+ "type": "object"
},
"ExportVariantSetRequest": {
- "description": "The variant data export request.",
- "type": "object",
"properties": {
"format": {
+ "enum": [
+ "FORMAT_UNSPECIFIED",
+ "FORMAT_BIGQUERY"
+ ],
"description": "The format for the exported data.",
"type": "string",
"enumDescriptions": [
"",
"Export the data to Google BigQuery."
- ],
- "enum": [
- "FORMAT_UNSPECIFIED",
- "FORMAT_BIGQUERY"
]
},
"bigqueryDataset": {
@@ -3255,28 +3342,12 @@
"type": "string"
}
},
- "id": "ExportVariantSetRequest"
+ "id": "ExportVariantSetRequest",
+ "description": "The variant data export request.",
+ "type": "object"
},
"SearchAnnotationsRequest": {
- "type": "object",
"properties": {
- "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,\nreferenceId or\nreferenceName\nmust be specified. Defaults to 0.",
- "format": "int64",
- "type": "string"
- },
- "annotationSetIds": {
- "description": "Required. The annotation sets to search within. The caller must have\n`READ` access to these annotation sets.\nAll queried annotation sets must have the same type.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"referenceName": {
"description": "The name of the reference to query, within the reference set associated\nwith this query.",
"type": "string"
@@ -3293,14 +3364,35 @@
"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,\nreferenceId or\nreferenceName\nmust be specified. Defaults to 0.",
+ "format": "int64",
+ "type": "string"
+ },
+ "annotationSetIds": {
+ "description": "Required. The annotation sets to search within. The caller must have\n`READ` access to these annotation sets.\nAll queried annotation sets must have the same type.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
- "id": "SearchAnnotationsRequest"
+ "id": "SearchAnnotationsRequest",
+ "type": "object"
},
"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"
@@ -3309,14 +3401,11 @@
"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"
}
},
- "id": "OperationEvent"
+ "id": "OperationEvent",
+ "description": "An event that occurred during an Operation.",
+ "type": "object"
},
"CodingSequence": {
"type": "object",
@@ -3335,8 +3424,6 @@
"id": "CodingSequence"
},
"TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
@@ -3346,7 +3433,9 @@
}
}
},
- "id": "TestIamPermissionsResponse"
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object"
},
"GetIamPolicyRequest": {
"description": "Request message for `GetIamPolicy` method.",
@@ -3355,7 +3444,6 @@
"id": "GetIamPolicyRequest"
},
"SearchReferencesResponse": {
- "type": "object",
"properties": {
"references": {
"description": "The matching references.",
@@ -3369,15 +3457,12 @@
"type": "string"
}
},
- "id": "SearchReferencesResponse"
+ "id": "SearchReferencesResponse",
+ "type": "object"
},
"SearchAnnotationSetsRequest": {
"type": "object",
"properties": {
- "referenceSetId": {
- "description": "If specified, only annotation sets associated with the given reference set\nare returned.",
- "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"
@@ -3395,29 +3480,33 @@
}
},
"types": {
- "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"
- ]
- },
"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": {
+ "enum": [
+ "ANNOTATION_TYPE_UNSPECIFIED",
+ "GENERIC",
+ "VARIANT",
+ "GENE",
+ "TRANSCRIPT"
+ ],
+ "type": "string"
+ }
},
"name": {
"description": "Only return annotations sets for which a substring of the name matches this\nstring (case insensitive).",
"type": "string"
+ },
+ "referenceSetId": {
+ "description": "If specified, only annotation sets associated with the given reference set\nare returned.",
+ "type": "string"
}
},
"id": "SearchAnnotationSetsRequest"
@@ -3444,9 +3533,14 @@
"description": "A linear alignment can be represented by one CIGAR string. Describes the\nmapped position and local alignment of the read to the reference.",
"type": "object",
"properties": {
+ "mappingQuality": {
+ "description": "The mapping quality of this alignment. Represents how likely\nthe read maps to this position as opposed to other locations.\n\nSpecifically, this is -10 log10 Pr(mapping position is wrong), rounded to\nthe nearest integer.",
+ "format": "int32",
+ "type": "integer"
+ },
"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.",
@@ -3454,11 +3548,6 @@
"items": {
"$ref": "CigarUnit"
}
- },
- "mappingQuality": {
- "description": "The mapping quality of this alignment. Represents how likely\nthe read maps to this position as opposed to other locations.\n\nSpecifically, this is -10 log10 Pr(mapping position is wrong), rounded to\nthe nearest integer.",
- "format": "int32",
- "type": "integer"
}
},
"id": "LinearAlignment"
@@ -3466,13 +3555,6 @@
"SearchReferencesRequest": {
"type": "object",
"properties": {
- "md5checksums": {
- "description": "If present, return references for which the\nmd5checksum matches exactly.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"accessions": {
"description": "If present, return references for which a prefix of any of\nsourceAccessions match\nany of these strings. Accession numbers typically have a main number and a\nversion, for example `GCF_000001405.26`.",
"type": "array",
@@ -3492,14 +3574,23 @@
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 4096.",
"format": "int32",
"type": "integer"
+ },
+ "md5checksums": {
+ "description": "If present, return references for which the\nmd5checksum matches exactly.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"id": "SearchReferencesRequest"
},
"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": {
+ "id": {
+ "description": "The server-generated dataset ID, unique across all datasets.",
+ "type": "string"
+ },
"createTime": {
"description": "The time this dataset was created, in seconds from the epoch.",
"format": "google-datetime",
@@ -3512,17 +3603,13 @@
"projectId": {
"description": "The Google Cloud project ID that this dataset belongs to.",
"type": "string"
- },
- "id": {
- "description": "The server-generated dataset ID, unique across all datasets.",
- "type": "string"
}
},
- "id": "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"
},
"ImportVariantsResponse": {
- "description": "The variant data import response.",
- "type": "object",
"properties": {
"callSetIds": {
"description": "IDs of the call sets created during the import.",
@@ -3532,12 +3619,24 @@
}
}
},
- "id": "ImportVariantsResponse"
+ "id": "ImportVariantsResponse",
+ "description": "The variant data import response.",
+ "type": "object"
},
"ReadGroup": {
- "description": "A read group is all the data that's processed the same way by the sequencer.",
- "type": "object",
"properties": {
+ "predictedInsertSize": {
+ "description": "The predicted insert size of this read group. The insert size is the length\nthe sequenced DNA fragment from end-to-end, not including the adapters.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "programs": {
+ "description": "The programs used to generate this read group. Programs are always\nidentical for all read groups within a read group set. For this reason,\nonly the first read group in a returned set will have this field\npopulated.",
+ "type": "array",
+ "items": {
+ "$ref": "Program"
+ }
+ },
"description": {
"description": "A free-form text description of this read group.",
"type": "string"
@@ -3551,8 +3650,8 @@
"type": "string"
},
"experiment": {
- "$ref": "Experiment",
- "description": "The experiment used to generate this read group."
+ "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.",
@@ -3575,25 +3674,13 @@
"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"
- },
- "predictedInsertSize": {
- "description": "The predicted insert size of this read group. The insert size is the length\nthe sequenced DNA fragment from end-to-end, not including the adapters.",
- "format": "int32",
- "type": "integer"
- },
- "programs": {
- "description": "The programs used to generate this read group. Programs are always\nidentical for all read groups within a read group set. For this reason,\nonly the first read group in a returned set will have this field\npopulated.",
- "type": "array",
- "items": {
- "$ref": "Program"
- }
}
},
- "id": "ReadGroup"
+ "id": "ReadGroup",
+ "description": "A read group is all the data that's processed the same way by the sequencer.",
+ "type": "object"
},
"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": {
"datasetId": {
"description": "The dataset to which this read group set belongs.",
@@ -3619,52 +3706,54 @@
"type": "string"
},
"info": {
- "description": "A map of additional read group set information.",
- "type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "any"
}
- }
+ },
+ "description": "A map of additional read group set information.",
+ "type": "object"
},
"id": {
"description": "The server-generated read group set ID, unique for all read group sets.",
"type": "string"
}
},
- "id": "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"
},
"SearchVariantSetsResponse": {
"description": "The search variant sets 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"
+ },
"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"
}
},
"id": "SearchVariantSetsResponse"
},
"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"
},
"Entry": {
"type": "object",
"properties": {
"status": {
- "$ref": "Status",
- "description": "The creation status."
+ "description": "The creation status.",
+ "$ref": "Status"
},
"annotation": {
"description": "The created annotation, if creation was successful.",
@@ -3677,11 +3766,6 @@
"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"
@@ -3689,89 +3773,14 @@
"reverseStrand": {
"description": "Whether this position is on the reverse strand, as opposed to the forward\nstrand.",
"type": "boolean"
+ },
+ "position": {
+ "description": "The 0-based offset from the start of the forward strand for that reference.",
+ "format": "int64",
+ "type": "string"
}
},
"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": {
- "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"
- }
- }
- },
- "id": "SearchCallSetsRequest"
- },
- "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"
- }
- }
- },
- "id": "ImportReadGroupSetsRequest"
}
},
"icons": {
@@ -3784,6 +3793,12 @@
"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/genomics.readonly": {
+ "description": "View Genomics data"
+ },
"https://www.googleapis.com/auth/genomics": {
"description": "View and manage Genomics data"
},
@@ -3792,26 +3807,11 @@
},
"https://www.googleapis.com/auth/devstorage.read_write": {
"description": "Manage your data in Google Cloud Storage"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/genomics.readonly": {
- "description": "View Genomics data"
}
}
}
},
"kind": "discovery#restDescription",
"description": "Upload, process, query, and search Genomics data in the cloud.",
- "servicePath": "",
- "rootUrl": "https://genomics.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "genomics",
- "batchPath": "batch",
- "revision": "20171207",
- "id": "genomics:v1",
- "documentationLink": "https://cloud.google.com/genomics",
- "title": "Genomics API"
+ "servicePath": ""
}
diff --git a/genomics/v1alpha2/genomics-api.json b/genomics/v1alpha2/genomics-api.json
index dd83687..c1520e6 100644
--- a/genomics/v1alpha2/genomics-api.json
+++ b/genomics/v1alpha2/genomics-api.json
@@ -1,184 +1,38 @@
{
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
- "pipelines": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListPipelinesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Number of pipelines to return at once. Defaults to 256, and max\nis 2048.",
- "format": "int32",
- "type": "integer"
- },
- "projectId": {
- "description": "Required. The name of the project to search for pipelines. Caller\nmust have READ access to this project.",
- "type": "string",
- "location": "query"
- },
- "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"
- }
- },
- "flatPath": "v1alpha2/pipelines",
- "path": "v1alpha2/pipelines",
- "id": "genomics.pipelines.list",
- "description": "Lists pipelines.\n\nCaller must have READ permission to the project."
- },
- "create": {
- "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.",
- "request": {
- "$ref": "Pipeline"
- },
- "response": {
- "$ref": "Pipeline"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1alpha2/pipelines",
- "path": "v1alpha2/pipelines",
- "id": "genomics.pipelines.create"
- },
- "run": {
- "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.",
- "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"
- ]
- },
- "get": {
- "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.",
- "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"
- }
- }
- },
- "setOperationStatus": {
- "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"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {}
- },
- "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": {
- "location": "query",
- "description": "The operation to retrieve controller configuration for.",
- "type": "string"
- },
- "validationToken": {
- "location": "query",
- "format": "uint64",
- "type": "string"
- }
- }
- },
- "delete": {
- "description": "Deletes a pipeline based on ID.\n\nCaller must have WRITE permission to the project.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "pipelineId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "pipelineId": {
- "location": "path",
- "description": "Caller must have WRITE 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.delete"
- }
- }
- },
"operations": {
"methods": {
+ "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/.+$"
+ }
+ }
+ },
"list": {
"description": "Lists operations that match the specified filter in the request.",
"response": {
@@ -188,21 +42,11 @@
"name"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
"parameters": {
- "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": {
- "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"
+ "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`"
},
"name": {
"description": "The name of the operation's parent resource.",
@@ -212,19 +56,26 @@
"location": "path"
},
"pageToken": {
+ "location": "query",
"description": "The standard list page token.",
- "type": "string",
+ "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"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
"flatPath": "v1alpha2/operations",
"path": "v1alpha2/{+name}",
"id": "genomics.operations.list"
},
"get": {
- "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.",
"response": {
"$ref": "Operation"
@@ -245,43 +96,245 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
- ]
- },
- "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"
],
+ "flatPath": "v1alpha2/operations/{operationsId}",
+ "path": "v1alpha2/{+name}",
+ "id": "genomics.operations.get"
+ }
+ }
+ },
+ "pipelines": {
+ "methods": {
+ "create": {
+ "response": {
+ "$ref": "Pipeline"
+ },
+ "parameterOrder": [],
"httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
+ "flatPath": "v1alpha2/pipelines",
+ "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."
+ },
+ "run": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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",
+ "id": "genomics.pipelines.run",
+ "path": "v1alpha2/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."
+ },
+ "get": {
+ "response": {
+ "$ref": "Pipeline"
+ },
+ "parameterOrder": [
+ "pipelineId"
+ ],
+ "httpMethod": "GET",
"parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
+ "pipelineId": {
+ "location": "path",
+ "description": "Caller must have READ 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.get",
+ "description": "Retrieves a pipeline based on ID.\n\nCaller must have READ permission to the project."
+ },
+ "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": {
+ "response": {
+ "$ref": "ControllerConfig"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "operationId": {
+ "description": "The operation to retrieve controller configuration for.",
+ "type": "string",
+ "location": "query"
+ },
+ "validationToken": {
+ "type": "string",
+ "location": "query",
+ "format": "uint64"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "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."
+ },
+ "delete": {
+ "description": "Deletes a pipeline based on ID.\n\nCaller must have WRITE permission to the project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "pipelineId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "pipelineId": {
+ "description": "Caller must have WRITE access to the project in which this pipeline\nis defined.",
"required": true,
"type": "string",
- "pattern": "^operations/.+$",
"location": "path"
}
},
- "flatPath": "v1alpha2/operations/{operationsId}:cancel",
- "path": "v1alpha2/{+name}:cancel",
- "id": "genomics.operations.cancel"
+ "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"
+ },
+ "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."
}
}
}
},
"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"
+ },
+ "oauth_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
+ },
+ "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",
+ "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": {
+ "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",
@@ -291,15 +344,15 @@
"enum": [
"1",
"2"
- ]
+ ],
+ "description": "V1 error format."
},
"callback": {
+ "type": "string",
"location": "query",
- "description": "JSONP",
- "type": "string"
+ "description": "JSONP"
},
"alt": {
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -312,185 +365,16 @@
"json",
"media",
"proto"
- ]
- },
- "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"
- },
- "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"
}
},
"schemas": {
- "OperationEvent": {
- "description": "An event that occurred during an Operation.",
- "type": "object",
- "properties": {
- "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"
- },
- "startTime": {
- "description": "Optional time of when event started.",
- "format": "google-datetime",
- "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": {
- "image": {
- "type": "string"
- },
- "gcsLogPath": {
- "type": "string"
- },
- "gcsSources": {
- "type": "object",
- "additionalProperties": {
- "$ref": "RepeatedString"
- }
- },
- "gcsSinks": {
- "additionalProperties": {
- "$ref": "RepeatedString"
- },
- "type": "object"
- },
- "disks": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "machineType": {
- "type": "string"
- },
- "cmd": {
- "type": "string"
- },
- "vars": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "id": "ControllerConfig"
- },
- "RepeatedString": {
- "type": "object",
- "properties": {
- "values": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "RepeatedString"
- },
- "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": {
+ "id": "OperationMetadata",
"description": "Metadata describing an Operation.",
"type": "object",
"properties": {
- "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"
- }
- },
- "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.",
@@ -500,12 +384,17 @@
"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"
+ },
+ "createTime": {
+ "description": "The time at which the job was submitted to the Genomics service.",
+ "format": "google-datetime",
+ "type": "string"
},
"labels": {
"additionalProperties": {
@@ -514,13 +403,32 @@
"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.",
+ "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": {
+ "type": "string",
+ "description": "The time at which the job began to run.",
+ "format": "google-datetime"
}
- },
- "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.",
@@ -531,39 +439,17 @@
"type": "string"
},
"pipelines": {
- "description": "The matched pipelines.",
"type": "array",
"items": {
"$ref": "Pipeline"
- }
+ },
+ "description": "The matched pipelines."
}
},
"id": "ListPipelinesResponse"
},
"RunPipelineArgs": {
- "description": "The pipeline run arguments.",
- "type": "object",
"properties": {
- "logging": {
- "description": "Required. Logging options. Used by the service to communicate results\nto the user.",
- "$ref": "LoggingOptions"
- },
- "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"
- }
- },
- "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"
@@ -571,6 +457,15 @@
"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"
@@ -579,19 +474,32 @@
"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"
- },
- "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"
+ },
+ "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": {
+ "description": "Required. Logging options. Used by the service to communicate results\nto the user.",
+ "$ref": "LoggingOptions"
}
},
- "id": "RunPipelineArgs"
+ "id": "RunPipelineArgs",
+ "description": "The pipeline run arguments.",
+ "type": "object"
},
"SetOperationStatusRequest": {
"description": "Request to set operation status. Should only be used by VMs\ncreated by the Pipelines Service and not by end users.",
@@ -608,6 +516,7 @@
"type": "string"
},
"errorCode": {
+ "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",
@@ -645,8 +554,7 @@
"INTERNAL",
"UNAVAILABLE",
"DATA_LOSS"
- ],
- "type": "string"
+ ]
},
"timestampEvents": {
"type": "array",
@@ -688,11 +596,11 @@
"type": "object",
"properties": {
"callSetIds": {
- "description": "IDs of the call sets created during the import.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "IDs of the call sets created during the import."
}
},
"id": "ImportVariantsResponse"
@@ -701,14 +609,14 @@
"description": "Stores the list of events and times they occured for major events in job\nexecution.",
"type": "object",
"properties": {
- "timestamp": {
- "description": "The time this event occured.",
- "format": "google-datetime",
- "type": "string"
- },
"description": {
- "description": "String indicating the type of event",
- "type": "string"
+ "type": "string",
+ "description": "String indicating the type of event"
+ },
+ "timestamp": {
+ "type": "string",
+ "description": "The time this event occured.",
+ "format": "google-datetime"
}
},
"id": "TimestampEvent"
@@ -747,7 +655,12 @@
"description": "A Google Compute Engine disk resource specification.",
"type": "object",
"properties": {
+ "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"
+ },
"type": {
+ "type": "string",
"enumDescriptions": [
"Default disk type. Use one of the other options below.",
"Specifies a Google Compute Engine persistent hard disk. See\nhttps://cloud.google.com/compute/docs/disks/#pdspecs for details.",
@@ -760,17 +673,16 @@
"PERSISTENT_SSD",
"LOCAL_SSD"
],
- "description": "Required. The type of the disk to create.",
- "type": "string"
+ "description": "Required. The type of the disk to create."
},
"autoDelete": {
"description": "Deprecated. Disks created by the Pipelines API will be deleted at the end\nof the pipeline run, regardless of what this field is set to.",
"type": "boolean"
},
"sizeGb": {
+ "type": "integer",
"description": "The size of the disk. Defaults to 500 (GB).\nThis field is not applicable for local SSD.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"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`.",
@@ -783,10 +695,6 @@
"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"
}
},
"id": "Disk"
@@ -801,14 +709,6 @@
"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"
- },
- "localCopy": {
- "$ref": "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."
- },
"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"
@@ -816,6 +716,14 @@
"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"
}
},
"id": "PipelineParameter"
@@ -832,12 +740,11 @@
"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."
+ "description": "The arguments to use when running this pipeline.",
+ "$ref": "RunPipelineArgs"
},
"pipelineId": {
"description": "The already created pipeline to run.",
@@ -848,7 +755,8 @@
"$ref": "Pipeline"
}
},
- "id": "RunPipelineRequest"
+ "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."
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
@@ -856,17 +764,6 @@
"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",
@@ -876,12 +773,12 @@
"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"
- }
+ },
+ "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`",
@@ -892,16 +789,27 @@
"$ref": "Status"
},
"metadata": {
- "description": "An OperationMetadata object. This will always be returned with the Operation.",
- "type": "object",
"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"
},
+ "RuntimeMetadata": {
+ "description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.",
+ "type": "object",
+ "properties": {
+ "computeEngine": {
+ "description": "Execution information specific to Google Compute Engine.",
+ "$ref": "ComputeEngine"
+ }
+ },
+ "id": "RuntimeMetadata"
+ },
"ImportReadGroupSetsResponse": {
"description": "The read group set import response.",
"type": "object",
@@ -924,11 +832,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"
+ }
}
},
"code": {
@@ -937,8 +845,8 @@
"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."
}
},
"id": "Status"
@@ -962,9 +870,24 @@
"id": "ServiceAccount"
},
"PipelineResources": {
+ "id": "PipelineResources",
"description": "The system resources for the pipeline run.",
"type": "object",
"properties": {
+ "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"
@@ -996,28 +919,29 @@
"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"
}
- },
- "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": {
+ "$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"
+ },
+ "pipelineId": {
+ "type": "string",
+ "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."
+ },
+ "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",
@@ -1025,59 +949,137 @@
"$ref": "PipelineParameter"
}
},
- "description": {
- "description": "User-specified description.",
- "type": "string"
- },
"docker": {
"$ref": "DockerExecutor",
"description": "Specifies the docker run information."
},
+ "description": {
+ "description": "User-specified description.",
+ "type": "string"
+ },
"inputParameters": {
- "description": "Input parameters of the pipeline.",
"type": "array",
"items": {
"$ref": "PipelineParameter"
- }
- },
- "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"
+ },
+ "description": "Input parameters of the pipeline."
}
},
"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": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "RepeatedString"
+ }
+ },
+ "disks": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "machineType": {
+ "type": "string"
+ },
+ "cmd": {
+ "type": "string"
+ },
+ "vars": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "image": {
+ "type": "string"
+ },
+ "gcsLogPath": {
+ "type": "string"
+ }
+ },
+ "id": "ControllerConfig"
+ },
+ "RepeatedString": {
+ "type": "object",
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "RepeatedString"
+ },
+ "ListOperationsResponse": {
+ "id": "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"
+ }
+ }
}
},
- "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": "v1alpha2",
"baseUrl": "https://genomics.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
- "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"
},
"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"
}
}
}
@@ -1093,7 +1095,5 @@
"revision": "20171207",
"documentationLink": "https://cloud.google.com/genomics",
"id": "genomics:v1alpha2",
- "title": "Genomics API",
- "discoveryVersion": "v1",
- "ownerName": "Google"
+ "title": "Genomics API"
}
diff --git a/iam/v1/iam-api.json b/iam/v1/iam-api.json
index 2ca012f..61f255c 100644
--- a/iam/v1/iam-api.json
+++ b/iam/v1/iam-api.json
@@ -1,188 +1,143 @@
{
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Identity and Access Management (IAM) API",
"ownerName": "Google",
"resources": {
"projects": {
"resources": {
"serviceAccounts": {
- "methods": {
- "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/[^/]+/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",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Tests the specified permissions against the IAM access control policy\nfor a ServiceAccount."
- },
- "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",
- "description": "Deletes a ServiceAccount.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE"
- },
- "list": {
- "response": {
- "$ref": "ListServiceAccountsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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"
+ "resources": {
+ "keys": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$",
+ "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"
+ }
+ },
+ "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."
},
- "pageToken": {
- "description": "Optional pagination token returned in an earlier\nListServiceAccountsResponse.next_page_token.",
- "type": "string",
- "location": "query"
+ "list": {
+ "id": "iam.projects.serviceAccounts.keys.list",
+ "path": "v1/{+name}/keys",
+ "description": "Lists ServiceAccountKeys.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListServiceAccountKeysResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "keyTypes": {
+ "enum": [
+ "KEY_TYPE_UNSPECIFIED",
+ "USER_MANAGED",
+ "SYSTEM_MANAGED"
+ ],
+ "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,
+ "location": "query"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys"
},
- "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"
+ "get": {
+ "response": {
+ "$ref": "ServiceAccountKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "publicKeyType": {
+ "location": "query",
+ "enum": [
+ "TYPE_NONE",
+ "TYPE_X509_PEM_FILE",
+ "TYPE_RAW_PUBLIC_KEY"
+ ],
+ "description": "The output format of the public key requested.\nX509_PEM is the default output format.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
+ "path": "v1/{+name}",
+ "id": "iam.projects.serviceAccounts.keys.get",
+ "description": "Gets the ServiceAccountKey\nby key id."
+ },
+ "create": {
+ "response": {
+ "$ref": "ServiceAccountKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "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"
+ }
+ },
+ "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",
+ "request": {
+ "$ref": "CreateServiceAccountKeyRequest"
+ },
+ "description": "Creates a ServiceAccountKey\nand returns it."
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts",
- "path": "v1/{+name}/serviceAccounts",
- "id": "iam.projects.serviceAccounts.list",
- "description": "Lists ServiceAccounts for a project."
- },
- "signBlob": {
- "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}: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"
- },
- "create": {
- "response": {
- "$ref": "ServiceAccount"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+$",
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/serviceAccounts",
- "path": "v1/{+name}/serviceAccounts",
- "id": "iam.projects.serviceAccounts.create",
- "description": "Creates a ServiceAccount\nand returns it.",
- "request": {
- "$ref": "CreateServiceAccountRequest"
}
- },
- "signJwt": {
- "id": "iam.projects.serviceAccounts.signJwt",
- "path": "v1/{+name}: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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "SignJwtResponse"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt"
- },
- "setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the IAM access control policy for a\nServiceAccount.",
+ }
+ },
+ "methods": {
+ "getIamPolicy": {
"httpMethod": "POST",
"parameterOrder": [
"resource"
@@ -190,23 +145,6 @@
"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": "^projects/[^/]+/serviceAccounts/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:setIamPolicy",
- "id": "iam.projects.serviceAccounts.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy"
- },
- "getIamPolicy": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -220,40 +158,33 @@
}
},
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
"id": "iam.projects.serviceAccounts.getIamPolicy",
- "description": "Returns the IAM access control policy for a\nServiceAccount.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST"
+ "path": "v1/{+resource}:getIamPolicy",
+ "description": "Returns the IAM access control policy for a\nServiceAccount."
},
"get": {
- "response": {
- "$ref": "ServiceAccount"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
- "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"
- }
+ "response": {
+ "$ref": "ServiceAccount"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "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"
+ }
+ },
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
- "path": "v1/{+name}",
"id": "iam.projects.serviceAccounts.get",
+ "path": "v1/{+name}",
"description": "Gets a ServiceAccount."
},
"update": {
@@ -283,172 +214,69 @@
"request": {
"$ref": "ServiceAccount"
}
- }
- },
- "resources": {
- "keys": {
- "methods": {
- "create": {
- "path": "v1/{+name}/keys",
- "id": "iam.projects.serviceAccounts.keys.create",
- "description": "Creates a ServiceAccountKey\nand returns it.",
- "request": {
- "$ref": "CreateServiceAccountKeyRequest"
- },
- "response": {
- "$ref": "ServiceAccountKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys"
- },
- "delete": {
- "path": "v1/{+name}",
- "id": "iam.projects.serviceAccounts.keys.delete",
- "description": "Deletes a ServiceAccountKey.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}"
- },
- "list": {
- "response": {
- "$ref": "ListServiceAccountKeysResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "keyTypes": {
- "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,
- "location": "query",
- "enum": [
- "KEY_TYPE_UNSPECIFIED",
- "USER_MANAGED",
- "SYSTEM_MANAGED"
- ]
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys",
- "path": "v1/{+name}/keys",
- "id": "iam.projects.serviceAccounts.keys.list",
- "description": "Lists ServiceAccountKeys."
- },
- "get": {
- "response": {
- "$ref": "ServiceAccountKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "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"
- },
- "publicKeyType": {
- "description": "The output format of the public key requested.\nX509_PEM is the default output format.",
- "type": "string",
- "location": "query",
- "enum": [
- "TYPE_NONE",
- "TYPE_X509_PEM_FILE",
- "TYPE_RAW_PUBLIC_KEY"
- ]
- }
- },
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
- "path": "v1/{+name}",
- "id": "iam.projects.serviceAccounts.keys.get",
- "description": "Gets the ServiceAccountKey\nby key id."
+ },
+ "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/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path"
}
- }
- }
- }
- },
- "roles": {
- "methods": {
- "create": {
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:testIamPermissions",
+ "id": "iam.projects.serviceAccounts.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Tests the specified permissions against the IAM access control policy\nfor a ServiceAccount."
+ },
+ "delete": {
+ "description": "Deletes a ServiceAccount.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
"parameters": {
- "parent": {
- "pattern": "^projects/[^/]+$",
+ "name": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
"location": "path",
- "description": "The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
+ "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"
}
},
- "flatPath": "v1/projects/{projectsId}/roles",
- "path": "v1/{+parent}/roles",
- "id": "iam.projects.roles.create",
- "description": "Creates a new Role.",
- "request": {
- "$ref": "CreateRoleRequest"
- },
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "parent"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
],
- "httpMethod": "POST"
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
+ "path": "v1/{+name}",
+ "id": "iam.projects.serviceAccounts.delete"
},
- "undelete": {
+ "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": "Role"
+ "$ref": "SignBlobResponse"
},
"parameterOrder": [
"name"
@@ -456,290 +284,145 @@
"httpMethod": "POST",
"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}`",
+ "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/[^/]+/roles/[^/]+$",
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/roles/{rolesId}:undelete",
- "path": "v1/{+name}:undelete",
- "id": "iam.projects.roles.undelete",
- "request": {
- "$ref": "UndeleteRoleRequest"
- },
- "description": "Undelete a Role, bringing it back in its previous state."
- },
- "get": {
- "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}",
- "id": "iam.projects.roles.get",
- "path": "v1/{+name}",
- "description": "Gets a Role definition.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Role"
- }
- },
- "patch": {
- "response": {
- "$ref": "Role"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "description": "A mask describing which fields in the Role have changed.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "name": {
- "pattern": "^projects/[^/]+/roles/[^/]+$",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
- "path": "v1/{+name}",
- "id": "iam.projects.roles.patch",
- "request": {
- "$ref": "Role"
- },
- "description": "Updates a Role definition."
- },
- "delete": {
- "httpMethod": "DELETE",
- "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"
- },
- "etag": {
- "location": "query",
- "description": "Used to perform a consistent read-modify-write.",
- "format": "byte",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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."
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob"
},
"list": {
+ "id": "iam.projects.serviceAccounts.list",
+ "path": "v1/{+name}/serviceAccounts",
+ "description": "Lists ServiceAccounts for a project.",
+ "httpMethod": "GET",
"response": {
- "$ref": "ListRolesResponse"
+ "$ref": "ListServiceAccountsResponse"
},
"parameterOrder": [
- "parent"
+ "name"
],
- "httpMethod": "GET",
"parameters": {
- "parent": {
+ "name": {
"pattern": "^projects/[^/]+$",
"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}`",
+ "description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.",
"required": true,
"type": "string"
},
- "showDeleted": {
- "description": "Include Roles that have been deleted.",
- "type": "boolean",
- "location": "query"
- },
"pageToken": {
"location": "query",
- "description": "Optional pagination token returned in an earlier ListRolesResponse.",
+ "description": "Optional pagination token returned in an earlier\nListServiceAccountsResponse.next_page_token.",
"type": "string"
},
"pageSize": {
- "location": "query",
- "description": "Optional limit on the number of roles to include in the response.",
+ "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"
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Optional view for the returned Role objects.",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts"
+ },
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "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}/roles",
- "path": "v1/{+parent}/roles",
- "id": "iam.projects.roles.list",
- "description": "Lists the Roles defined on a resource."
+ "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."
+ },
+ "signJwt": {
+ "response": {
+ "$ref": "SignJwtResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt",
+ "path": "v1/{+name}:signJwt",
+ "id": "iam.projects.serviceAccounts.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"
+ }
+ },
+ "create": {
+ "path": "v1/{+name}/serviceAccounts",
+ "id": "iam.projects.serviceAccounts.create",
+ "request": {
+ "$ref": "CreateServiceAccountRequest"
+ },
+ "description": "Creates a ServiceAccount\nand returns it.",
+ "response": {
+ "$ref": "ServiceAccount"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts"
}
}
- }
- }
- },
- "roles": {
- "methods": {
- "queryGrantableRoles": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/roles:queryGrantableRoles",
- "path": "v1/roles:queryGrantableRoles",
- "id": "iam.roles.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"
- },
- "list": {
- "parameters": {
- "pageToken": {
- "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": {
- "description": "Optional view for the returned Role objects.",
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ]
- },
- "parent": {
- "location": "query",
- "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"
- },
- "showDeleted": {
- "location": "query",
- "description": "Include Roles that have been deleted.",
- "type": "boolean"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/roles",
- "id": "iam.roles.list",
- "path": "v1/roles",
- "description": "Lists the Roles defined on a resource.",
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListRolesResponse"
- }
},
- "get": {
- "parameters": {
- "name": {
- "pattern": "^roles/[^/]+$",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/roles/{rolesId}",
- "id": "iam.roles.get",
- "path": "v1/{+name}",
- "description": "Gets a Role definition.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Role"
- }
- }
- }
- },
- "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"
- },
- "response": {
- "$ref": "QueryTestablePermissionsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/permissions:queryTestablePermissions",
- "path": "v1/permissions:queryTestablePermissions",
- "id": "iam.permissions.queryTestablePermissions"
- }
- }
- },
- "organizations": {
- "resources": {
"roles": {
"methods": {
"undelete": {
"path": "v1/{+name}:undelete",
- "id": "iam.organizations.roles.undelete",
+ "id": "iam.projects.roles.undelete",
"request": {
"$ref": "UndeleteRoleRequest"
},
@@ -756,14 +439,14 @@
"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/[^/]+$",
+ "pattern": "^projects/[^/]+/roles/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}:undelete"
+ "flatPath": "v1/projects/{projectsId}/roles/{rolesId}:undelete"
},
"get": {
"description": "Gets a Role definition.",
@@ -779,18 +462,24 @@
"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/[^/]+$",
+ "pattern": "^projects/[^/]+/roles/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
- "id": "iam.organizations.roles.get",
+ "flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
+ "id": "iam.projects.roles.get",
"path": "v1/{+name}"
},
"patch": {
+ "path": "v1/{+name}",
+ "id": "iam.projects.roles.patch",
+ "description": "Updates a Role definition.",
+ "request": {
+ "$ref": "Role"
+ },
"response": {
"$ref": "Role"
},
@@ -798,6 +487,9 @@
"name"
],
"httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"updateMask": {
"description": "A mask describing which fields in the Role have changed.",
@@ -809,23 +501,13 @@
"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/[^/]+$",
+ "pattern": "^projects/[^/]+/roles/[^/]+$",
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
- "path": "v1/{+name}",
- "id": "iam.organizations.roles.patch",
- "request": {
- "$ref": "Role"
- },
- "description": "Updates a Role definition."
+ "flatPath": "v1/projects/{projectsId}/roles/{rolesId}"
},
"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.",
"response": {
"$ref": "Role"
},
@@ -837,26 +519,26 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "name": {
- "pattern": "^organizations/[^/]+/roles/[^/]+$",
- "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"
- },
"etag": {
"location": "query",
"description": "Used to perform a consistent read-modify-write.",
"format": "byte",
"type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/roles/[^/]+$",
+ "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"
}
},
- "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
+ "flatPath": "v1/projects/{projectsId}/roles/{rolesId}",
"path": "v1/{+name}",
- "id": "iam.organizations.roles.delete"
+ "id": "iam.projects.roles.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."
},
"list": {
- "description": "Lists the Roles defined on a resource.",
"response": {
"$ref": "ListRolesResponse"
},
@@ -877,35 +559,198 @@
"type": "integer"
},
"view": {
- "description": "Optional view for the returned Role objects.",
- "type": "string",
- "location": "query",
"enum": [
"BASIC",
"FULL"
- ]
+ ],
+ "description": "Optional view for the returned Role objects.",
+ "type": "string",
+ "location": "query"
},
"parent": {
- "pattern": "^organizations/[^/]+$",
+ "pattern": "^projects/[^/]+$",
"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"
},
"showDeleted": {
- "location": "query",
"description": "Include Roles that have been deleted.",
- "type": "boolean"
+ "type": "boolean",
+ "location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/organizations/{organizationsId}/roles",
+ "flatPath": "v1/projects/{projectsId}/roles",
"path": "v1/{+parent}/roles",
- "id": "iam.organizations.roles.list"
+ "id": "iam.projects.roles.list",
+ "description": "Lists the Roles defined on a resource."
},
"create": {
+ "path": "v1/{+parent}/roles",
+ "id": "iam.projects.roles.create",
+ "request": {
+ "$ref": "CreateRoleRequest"
+ },
+ "description": "Creates a new Role.",
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/roles"
+ }
+ }
+ }
+ }
+ },
+ "roles": {
+ "methods": {
+ "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"
+ },
+ "list": {
+ "description": "Lists the Roles defined on a resource.",
+ "response": {
+ "$ref": "ListRolesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "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",
+ "location": "query"
+ },
+ "view": {
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Optional view for the returned Role objects.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "location": "query",
+ "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"
+ },
+ "showDeleted": {
+ "location": "query",
+ "description": "Include Roles that have been deleted.",
+ "type": "boolean"
+ }
+ },
+ "flatPath": "v1/roles",
+ "path": "v1/roles",
+ "id": "iam.roles.list"
+ },
+ "get": {
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^roles/[^/]+$",
+ "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"
+ }
+ },
+ "flatPath": "v1/roles/{rolesId}",
+ "path": "v1/{+name}",
+ "id": "iam.roles.get",
+ "description": "Gets a Role definition."
+ }
+ }
+ },
+ "permissions": {
+ "methods": {
+ "queryTestablePermissions": {
+ "path": "v1/permissions:queryTestablePermissions",
+ "id": "iam.permissions.queryTestablePermissions",
+ "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"
+ ],
+ "flatPath": "v1/permissions:queryTestablePermissions"
+ }
+ }
+ },
+ "organizations": {
+ "resources": {
+ "roles": {
+ "methods": {
+ "create": {
+ "request": {
+ "$ref": "CreateRoleRequest"
+ },
+ "description": "Creates a new Role.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Role"
+ },
"parameters": {
"parent": {
"description": "The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`",
@@ -920,18 +765,175 @@
],
"flatPath": "v1/organizations/{organizationsId}/roles",
"id": "iam.organizations.roles.create",
- "path": "v1/{+parent}/roles",
+ "path": "v1/{+parent}/roles"
+ },
+ "patch": {
+ "id": "iam.organizations.roles.patch",
+ "path": "v1/{+name}",
"request": {
- "$ref": "CreateRoleRequest"
+ "$ref": "Role"
},
- "description": "Creates a new Role.",
+ "description": "Updates a Role definition.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Role"
+ },
+ "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": "^organizations/[^/]+/roles/[^/]+$",
+ "location": "path"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "A mask describing which fields in the Role have changed.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}"
+ },
+ "undelete": {
+ "description": "Undelete a Role, bringing it back in its previous state.",
+ "request": {
+ "$ref": "UndeleteRoleRequest"
+ },
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
"httpMethod": "POST",
+ "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": "^organizations/[^/]+/roles/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}:undelete",
+ "path": "v1/{+name}:undelete",
+ "id": "iam.organizations.roles.undelete"
+ },
+ "get": {
+ "description": "Gets a Role definition.",
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^organizations/[^/]+/roles/[^/]+$",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
+ "path": "v1/{+name}",
+ "id": "iam.organizations.roles.get"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Role"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "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`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/roles/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}",
+ "path": "v1/{+name}",
+ "id": "iam.organizations.roles.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."
+ },
+ "list": {
+ "id": "iam.organizations.roles.list",
+ "path": "v1/{+parent}/roles",
+ "description": "Lists the Roles defined on a resource.",
+ "httpMethod": "GET",
"parameterOrder": [
"parent"
],
"response": {
- "$ref": "Role"
- }
+ "$ref": "ListRolesResponse"
+ },
+ "parameters": {
+ "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",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "Optional pagination token returned in an earlier ListRolesResponse.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional limit on the number of roles to include in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "view": {
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Optional view for the returned Role objects.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/organizations/{organizationsId}/roles"
}
}
}
@@ -939,11 +941,22 @@
}
},
"parameters": {
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "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.",
@@ -961,14 +974,14 @@
"location": "query"
},
"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",
- "location": "query"
+ "type": "string"
},
"$.xgafv": {
"enumDescriptions": [
@@ -989,47 +1002,36 @@
"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"
+ ],
+ "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"
+ "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"
+ "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://iam.googleapis.com/",
- "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.",
"kind": "discovery#restDescription",
+ "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": "",
"id": "iam:v1",
@@ -1039,14 +1041,9 @@
"version_module": true,
"schemas": {
"Role": {
- "id": "Role",
"description": "A role in the Identity and Access Management API.",
"type": "object",
"properties": {
- "title": {
- "description": "Optional. A human-readable title for the role. Typically this\nis limited to 100 UTF-8 bytes.",
- "type": "string"
- },
"includedPermissions": {
"description": "The names of the permissions this role grants when bound in an IAM policy.",
"type": "array",
@@ -1064,14 +1061,6 @@
"type": "string"
},
"stage": {
- "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.",
- "The user has indicated this role is generally available.",
- "The user has indicated this role is being deprecated.",
- "This role is disabled and will not contribute permissions to any members\nit is granted to in policies.",
- "The user has indicated this role is currently in an eap phase."
- ],
"enum": [
"ALPHA",
"BETA",
@@ -1081,7 +1070,15 @@
"EAP"
],
"description": "The current launch stage of the role.",
- "type": "string"
+ "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.",
+ "The user has indicated this role is generally available.",
+ "The user has indicated this role is being deprecated.",
+ "This role is disabled and will not contribute permissions to any members\nit is granted to in policies.",
+ "The user has indicated this role is currently in an eap phase."
+ ]
},
"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.",
@@ -1090,11 +1087,15 @@
"deleted": {
"description": "The current deleted state of the role. This field is read only.\nIt will be ignored in calls to CreateRole and UpdateRole.",
"type": "boolean"
+ },
+ "title": {
+ "description": "Optional. A human-readable title for the role. Typically this\nis limited to 100 UTF-8 bytes.",
+ "type": "string"
}
- }
+ },
+ "id": "Role"
},
"Binding": {
- "id": "Binding",
"description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
@@ -1109,21 +1110,11 @@
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
}
- }
+ },
+ "id": "Binding"
},
"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\"",
- "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"
@@ -1131,14 +1122,32 @@
"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"
+ },
+ "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"
}
- }
+ },
+ "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"
},
"ServiceAccount": {
- "id": "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": {
+ "uniqueId": {
+ "description": "@OutputOnly The unique and stable id of the service account.",
+ "type": "string"
+ },
+ "oauth2ClientId": {
+ "description": "@OutputOnly The OAuth2 client id for the service account.\nThis is used in conjunction with the OAuth2 clientconfig API to make\nthree legged OAuth2 (3LO) flows to access the data of Google users.",
+ "type": "string"
+ },
"displayName": {
"description": "Optional. A user-specified description of the service account. Must be\nfewer than 100 UTF-8 bytes.",
"type": "string"
@@ -1159,22 +1168,18 @@
"projectId": {
"description": "@OutputOnly The id of the project that owns the service account.",
"type": "string"
- },
- "oauth2ClientId": {
- "description": "@OutputOnly The OAuth2 client id for the service account.\nThis is used in conjunction with the OAuth2 clientconfig API to make\nthree legged OAuth2 (3LO) flows to access the data of Google users.",
- "type": "string"
- },
- "uniqueId": {
- "description": "@OutputOnly The unique and stable id of the service account.",
- "type": "string"
}
- }
+ },
+ "id": "ServiceAccount"
},
"QueryGrantableRolesRequest": {
- "id": "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"
@@ -1185,24 +1190,20 @@
"type": "integer"
},
"view": {
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
"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"
}
- }
+ },
+ "id": "QueryGrantableRolesRequest"
},
"CreateRoleRequest": {
- "id": "CreateRoleRequest",
"description": "The request to create a new role.",
"type": "object",
"properties": {
@@ -1211,30 +1212,25 @@
"type": "string"
},
"role": {
- "description": "The Role resource to create.",
- "$ref": "Role"
- }
- }
- },
- "QueryTestablePermissionsRequest": {
- "description": "A request to get permissions which can be tested on a resource.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
+ "$ref": "Role",
+ "description": "The Role resource to create."
}
},
- "id": "QueryTestablePermissionsRequest"
+ "id": "CreateRoleRequest"
+ },
+ "ListServiceAccountKeysResponse": {
+ "properties": {
+ "keys": {
+ "description": "The public keys for the service account.",
+ "type": "array",
+ "items": {
+ "$ref": "ServiceAccountKey"
+ }
+ }
+ },
+ "id": "ListServiceAccountKeysResponse",
+ "description": "The service account keys list response.",
+ "type": "object"
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
@@ -1250,25 +1246,38 @@
},
"id": "TestIamPermissionsResponse"
},
- "ListServiceAccountKeysResponse": {
- "description": "The service account keys list response.",
- "type": "object",
+ "QueryTestablePermissionsRequest": {
"properties": {
- "keys": {
- "description": "The public keys for the service account.",
- "type": "array",
- "items": {
- "$ref": "ServiceAccountKey"
- }
+ "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": "ListServiceAccountKeysResponse"
+ "id": "QueryTestablePermissionsRequest",
+ "description": "A request to get permissions which can be tested on a resource.",
+ "type": "object"
},
"ServiceAccountKey": {
- "id": "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"
@@ -1294,57 +1303,47 @@
"description": "Specifies the algorithm (and possibly key size) for the key.",
"type": "string"
},
+ "validAfterTime": {
+ "description": "The key can be used after this timestamp.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"privateKeyType": {
+ "enum": [
+ "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.",
"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.",
"Google Credentials File format."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "TYPE_PKCS12_FILE",
- "TYPE_GOOGLE_CREDENTIALS_FILE"
]
- },
- "validAfterTime": {
- "description": "The key can be used after this timestamp.",
- "format": "google-datetime",
- "type": "string"
- },
- "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"
}
- }
+ },
+ "id": "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"
},
"SignBlobResponse": {
- "description": "The service account sign blob response.",
- "type": "object",
"properties": {
+ "keyId": {
+ "description": "The id of the key used to sign the blob.",
+ "type": "string"
+ },
"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"
+ "id": "SignBlobResponse",
+ "description": "The service account sign blob response.",
+ "type": "object"
},
"Permission": {
- "id": "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.",
@@ -1359,26 +1358,20 @@
"type": "string"
},
"customRolesSupportLevel": {
- "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"
],
"description": "The current custom role support level.",
- "type": "string"
+ "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."
+ ]
},
"stage": {
- "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",
@@ -1386,24 +1379,33 @@
"DEPRECATED"
],
"description": "The current launch stage of the permission.",
- "type": "string"
+ "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."
+ ]
},
"name": {
"description": "The name of this Permission.",
"type": "string"
}
- }
+ },
+ "id": "Permission",
+ "description": "A permission which can be included by a role.",
+ "type": "object"
},
"SignJwtRequest": {
- "id": "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",
+ "description": "The service account sign JWT request.",
+ "type": "object"
},
"PolicyDelta": {
"description": "The difference delta between two policies.",
@@ -1420,8 +1422,6 @@
"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.",
@@ -1435,10 +1435,11 @@
}
}
},
- "id": "ListServiceAccountsResponse"
+ "id": "ListServiceAccountsResponse",
+ "description": "The service account list response.",
+ "type": "object"
},
"QueryGrantableRolesResponse": {
- "id": "QueryGrantableRolesResponse",
"description": "The grantable role query response.",
"type": "object",
"properties": {
@@ -1453,11 +1454,10 @@
"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.",
@@ -1465,21 +1465,22 @@
"type": "string"
}
},
- "id": "SignBlobRequest"
+ "id": "SignBlobRequest",
+ "description": "The service account sign blob request.",
+ "type": "object"
},
"SetIamPolicyRequest": {
- "id": "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"
},
"QueryTestablePermissionsResponse": {
- "id": "QueryTestablePermissionsResponse",
"description": "The response containing permissions which can be tested on a resource.",
"type": "object",
"properties": {
@@ -1494,26 +1495,20 @@
"description": "To retrieve the next page of results, set\n`QueryTestableRolesRequest.page_token` to this value.",
"type": "string"
}
- }
+ },
+ "id": "QueryTestablePermissionsResponse"
},
"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": {}
+ "type": "object"
},
"CreateServiceAccountKeyRequest": {
- "id": "CreateServiceAccountKeyRequest",
"description": "The service account key create request.",
"type": "object",
"properties": {
"keyAlgorithm": {
- "enumDescriptions": [
- "An unspecified key algorithm.",
- "1k RSA Key.",
- "2k RSA Key.",
- "HMAC."
- ],
"enum": [
"KEY_ALG_UNSPECIFIED",
"KEY_ALG_RSA_1024",
@@ -1521,28 +1516,32 @@
"KEY_ALG_GCS_SYMMETRIC_HMAC"
],
"description": "Which type of key and algorithm to use for the key.\nThe default is currently a 2K RSA key. However this may change in the\nfuture.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified key algorithm.",
+ "1k RSA Key.",
+ "2k RSA Key.",
+ "HMAC."
+ ]
},
"privateKeyType": {
- "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.",
- "Google Credentials File format."
- ],
"enum": [
"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"
+ "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.",
+ "Google Credentials File format."
+ ]
}
- }
+ },
+ "id": "CreateServiceAccountKeyRequest"
},
"SignJwtResponse": {
- "id": "SignJwtResponse",
- "description": "The service account sign JWT response.",
- "type": "object",
"properties": {
"keyId": {
"description": "The id of the key used to sign the JWT.",
@@ -1552,12 +1551,12 @@
"description": "The signed JWT.",
"type": "string"
}
- }
+ },
+ "id": "SignJwtResponse",
+ "description": "The service account sign JWT response.",
+ "type": "object"
},
"TestIamPermissionsRequest": {
- "id": "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).",
@@ -1566,13 +1565,18 @@
"type": "string"
}
}
- }
+ },
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object"
},
"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",
@@ -1584,16 +1588,13 @@
"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",
+ "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"
},
"ListRolesResponse": {
- "id": "ListRolesResponse",
"description": "The response containing the roles defined under a resource.",
"type": "object",
"properties": {
@@ -1608,23 +1609,21 @@
"description": "To retrieve the next page of results, set\n`ListRolesRequest.page_token` to this value.",
"type": "string"
}
- }
+ },
+ "id": "ListRolesResponse"
},
"AuditData": {
- "id": "AuditData",
- "description": "Audit log information specific to Cloud IAM. This message is serialized\nas an `Any` type in the `ServiceData` message of an\n`AuditLog` message.",
- "type": "object",
"properties": {
"policyDelta": {
- "$ref": "PolicyDelta",
- "description": "Policy delta between the original policy and the newly set policy."
+ "description": "Policy delta between the original policy and the newly set policy.",
+ "$ref": "PolicyDelta"
}
- }
+ },
+ "id": "AuditData",
+ "description": "Audit log information specific to Cloud IAM. This message is serialized\nas an `Any` type in the `ServiceData` message of an\n`AuditLog` message.",
+ "type": "object"
},
"BindingDelta": {
- "id": "BindingDelta",
- "description": "One delta entry for Binding. Each individual change (only one member in each\nentry) to a binding will be a separate entry.",
- "type": "object",
"properties": {
"action": {
"enumDescriptions": [
@@ -1645,18 +1644,19 @@
"type": "string"
},
"condition": {
- "description": "The condition that is associated with this binding.\nThis field is GOOGLE_INTERNAL.\nThis field is not logged in IAM side because it's only for audit logging.\nOptional",
- "$ref": "Expr"
+ "$ref": "Expr",
+ "description": "The condition that is associated with this binding.\nThis field is GOOGLE_INTERNAL.\nThis field is not logged in IAM side because it's only for audit logging.\nOptional"
},
"role": {
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
}
- }
+ },
+ "id": "BindingDelta",
+ "description": "One delta entry for Binding. Each individual change (only one member in each\nentry) to a binding will be a separate entry.",
+ "type": "object"
},
"UndeleteRoleRequest": {
- "description": "The request to undelete an existing role.",
- "type": "object",
"properties": {
"etag": {
"description": "Used to perform a consistent read-modify-write.",
@@ -1664,28 +1664,30 @@
"type": "string"
}
},
- "id": "UndeleteRoleRequest"
+ "id": "UndeleteRoleRequest",
+ "description": "The request to undelete an existing role.",
+ "type": "object"
},
"CreateServiceAccountRequest": {
- "description": "The service account create request.",
- "type": "object",
"properties": {
- "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"
+ },
+ "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"
}
},
- "id": "CreateServiceAccountRequest"
+ "id": "CreateServiceAccountRequest",
+ "description": "The service account create request.",
+ "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": "iam",
"auth": {
@@ -1700,7 +1702,5 @@
"rootUrl": "https://iam.googleapis.com/",
"ownerDomain": "google.com",
"name": "iam",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Google Identity and Access Management (IAM) API"
+ "batchPath": "batch"
}
diff --git a/kgsearch/v1/kgsearch-api.json b/kgsearch/v1/kgsearch-api.json
index e4dec1b..22cf4e8 100644
--- a/kgsearch/v1/kgsearch-api.json
+++ b/kgsearch/v1/kgsearch-api.json
@@ -1,34 +1,18 @@
{
- "ownerName": "Google",
- "discoveryVersion": "v1",
- "version_module": true,
"resources": {
"entities": {
"methods": {
"search": {
+ "flatPath": "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",
+ "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"
- },
- "query": {
- "location": "query",
- "description": "The literal query string for search.",
- "type": "string"
- },
- "types": {
- "location": "query",
- "description": "Restricts returned entities with these types, e.g. Person\n(as defined in http://schema.org/Person). If multiple types are specified,\nreturned entities will contain one or more of these types.",
- "type": "string",
- "repeated": true
- },
"indent": {
"location": "query",
"description": "Enables indenting of json results.",
@@ -41,35 +25,69 @@
"location": "query"
},
"ids": {
- "description": "The list of entity id to be used for search instead of query string.\nTo specify multiple ids in the HTTP request, repeat the parameter in the\nURL as in ...?ids=A&ids=B",
- "type": "string",
"repeated": true,
- "location": "query"
+ "location": "query",
+ "description": "The list of entity id to be used for search instead of query string.\nTo specify multiple ids in the HTTP request, repeat the parameter in the\nURL as in ...?ids=A&ids=B",
+ "type": "string"
},
"limit": {
"description": "Limits the number of entities to be returned.",
"format": "int32",
"type": "integer",
"location": "query"
+ },
+ "prefix": {
+ "description": "Enables prefix match against names and aliases of entities",
+ "type": "boolean",
+ "location": "query"
+ },
+ "query": {
+ "location": "query",
+ "description": "The literal query string for search.",
+ "type": "string"
+ },
+ "types": {
+ "location": "query",
+ "description": "Restricts returned entities with these types, e.g. Person\n(as defined in http://schema.org/Person). If multiple types are specified,\nreturned entities will contain one or more of these types.",
+ "type": "string",
+ "repeated": true
}
- },
- "flatPath": "v1/entities:search",
- "path": "v1/entities:search",
- "id": "kgsearch.entities.search"
+ }
}
}
}
},
"parameters": {
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "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": {
+ "type": "string",
"location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "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": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "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",
@@ -77,10 +95,10 @@
"type": "string"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
@@ -88,9 +106,9 @@
"location": "query"
},
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"callback": {
"location": "query",
@@ -111,6 +129,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",
@@ -118,34 +142,7 @@
],
"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": {
- "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": "json"
}
},
"schemas": {
@@ -165,23 +162,23 @@
}
},
"@type": {
- "description": "The schema type of top-level JSON-LD object, e.g. ItemList.",
- "type": "any"
+ "type": "any",
+ "description": "The schema type of top-level JSON-LD object, e.g. ItemList."
}
},
"id": "SearchResponse"
}
},
- "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",
"version": "v1",
"baseUrl": "https://kgsearch.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Searches the Google Knowledge Graph for entities.",
"servicePath": "",
+ "description": "Searches the Google Knowledge Graph for entities.",
+ "kind": "discovery#restDescription",
"rootUrl": "https://kgsearch.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
@@ -190,5 +187,8 @@
"revision": "20171103",
"documentationLink": "https://developers.google.com/knowledge-graph/",
"id": "kgsearch:v1",
- "title": "Knowledge Graph Search API"
+ "title": "Knowledge Graph Search API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
+ "version_module": true
}
diff --git a/language/v1/language-api.json b/language/v1/language-api.json
index 423338f..c1eac38 100644
--- a/language/v1/language-api.json
+++ b/language/v1/language-api.json
@@ -1,6 +1,551 @@
{
+ "ownerName": "Google",
+ "resources": {
+ "documents": {
+ "methods": {
+ "analyzeSyntax": {
+ "path": "v1/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"
+ },
+ "response": {
+ "$ref": "AnalyzeSyntaxResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/documents:analyzeSyntax"
+ },
+ "annotateText": {
+ "request": {
+ "$ref": "AnnotateTextRequest"
+ },
+ "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.",
+ "response": {
+ "$ref": "AnnotateTextResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/documents:annotateText",
+ "path": "v1/documents:annotateText",
+ "id": "language.documents.annotateText"
+ },
+ "classifyText": {
+ "description": "Classifies a document into categories.",
+ "request": {
+ "$ref": "ClassifyTextRequest"
+ },
+ "response": {
+ "$ref": "ClassifyTextResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/documents:classifyText",
+ "path": "v1/documents:classifyText",
+ "id": "language.documents.classifyText"
+ },
+ "analyzeSentiment": {
+ "response": {
+ "$ref": "AnalyzeSentimentResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/documents:analyzeSentiment",
+ "path": "v1/documents:analyzeSentiment",
+ "id": "language.documents.analyzeSentiment",
+ "description": "Analyzes the sentiment of the provided text.",
+ "request": {
+ "$ref": "AnalyzeSentimentRequest"
+ }
+ },
+ "analyzeEntitySentiment": {
+ "response": {
+ "$ref": "AnalyzeEntitySentimentResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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": {
+ "response": {
+ "$ref": "AnalyzeEntitiesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/documents:analyzeEntities",
+ "path": "v1/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": {
+ "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"
+ },
+ "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": {
+ "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"
+ },
+ "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://language.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20171212",
+ "documentationLink": "https://cloud.google.com/natural-language/",
+ "id": "language:v1",
+ "discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "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",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string"
+ },
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
+ }
+ },
+ "id": "AnalyzeSyntaxRequest"
+ },
+ "AnalyzeEntitiesResponse": {
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "Entity"
+ }
+ }
+ },
+ "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",
+ "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"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unknown",
+ "Person",
+ "Location",
+ "Organization",
+ "Event",
+ "Work of art",
+ "Consumer goods",
+ "Other types"
+ ],
+ "enum": [
+ "UNKNOWN",
+ "PERSON",
+ "LOCATION",
+ "ORGANIZATION",
+ "EVENT",
+ "WORK_OF_ART",
+ "CONSUMER_GOOD",
+ "OTHER"
+ ],
+ "description": "The entity type.",
+ "type": "string"
+ },
+ "metadata": {
+ "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.",
+ "type": "object"
+ },
+ "salience": {
+ "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",
+ "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"
+ }
+ },
+ "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.",
+ "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": {
+ "$ref": "Document",
+ "description": "Input document."
+ },
+ "features": {
+ "$ref": "Features",
+ "description": "The enabled features."
+ }
+ },
+ "id": "AnnotateTextRequest"
+ },
+ "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",
+ "UTF16",
+ "UTF32"
+ ],
+ "description": "The encoding type used by the API to calculate sentence offsets.",
+ "type": "string"
+ },
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
+ }
+ },
+ "id": "AnalyzeSentimentRequest"
+ },
+ "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"
+ },
+ "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.",
+ "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": {
+ "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": {
+ "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
+ "type": "string",
+ "enumDescriptions": [
+ "The content type is not specified.",
+ "Plain text",
+ "HTML"
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "PLAIN_TEXT",
+ "HTML"
+ ]
+ },
+ "content": {
+ "description": "The content of the input in string format.",
+ "type": "string"
+ }
+ },
+ "id": "Document"
+ },
+ "AnalyzeEntitiesRequest": {
+ "description": "The entity 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": {
+ "description": "Input document.",
+ "$ref": "Document"
+ }
+ },
+ "id": "AnalyzeEntitiesRequest"
+ },
+ "ClassifyTextRequest": {
+ "description": "The document classification request message.",
+ "type": "object",
+ "properties": {
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
+ }
+ },
+ "id": "ClassifyTextRequest"
+ },
+ "AnalyzeEntitySentimentResponse": {
+ "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"
+ }
+ }
+ },
+ "id": "AnalyzeEntitySentimentResponse",
+ "description": "The entity-level sentiment analysis response message.",
+ "type": "object"
+ },
+ "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": {
+ "description": "The overall sentiment of the input document.",
+ "$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.",
+ "type": "string"
+ }
+ },
+ "id": "AnalyzeSentimentResponse"
+ },
"AnalyzeSyntaxResponse": {
"description": "The syntax analysis response message.",
"type": "object",
@@ -30,27 +575,16 @@
"description": "The text annotations response message.",
"type": "object",
"properties": {
- "categories": {
- "description": "Categories identified in the input document.",
- "type": "array",
- "items": {
- "$ref": "ClassificationCategory"
- }
- },
- "documentSentiment": {
- "$ref": "Sentiment",
- "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_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.",
"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"
- },
- "description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities."
+ }
},
"sentences": {
"description": "Sentences in the input document. Populated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
@@ -65,15 +599,109 @@
"items": {
"$ref": "Token"
}
+ },
+ "categories": {
+ "description": "Categories identified in the input document.",
+ "type": "array",
+ "items": {
+ "$ref": "ClassificationCategory"
+ }
+ },
+ "documentSentiment": {
+ "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment.",
+ "$ref": "Sentiment"
}
},
"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": {
"label": {
+ "enumDescriptions": [
+ "Unknown",
+ "Abbreviation modifier",
+ "Adjectival complement",
+ "Adverbial clause modifier",
+ "Adverbial modifier",
+ "Adjectival modifier of an NP",
+ "Appositional modifier of an NP",
+ "Attribute dependent of a copular verb",
+ "Auxiliary (non-main) verb",
+ "Passive auxiliary",
+ "Coordinating conjunction",
+ "Clausal complement of a verb or adjective",
+ "Conjunct",
+ "Clausal subject",
+ "Clausal passive subject",
+ "Dependency (unable to determine)",
+ "Determiner",
+ "Discourse",
+ "Direct object",
+ "Expletive",
+ "Goes with (part of a word in a text not well edited)",
+ "Indirect object",
+ "Marker (word introducing a subordinate clause)",
+ "Multi-word expression",
+ "Multi-word verbal expression",
+ "Negation modifier",
+ "Noun compound modifier",
+ "Noun phrase used as an adverbial modifier",
+ "Nominal subject",
+ "Passive nominal subject",
+ "Numeric modifier of a noun",
+ "Element of compound number",
+ "Punctuation mark",
+ "Parataxis relation",
+ "Participial modifier",
+ "The complement of a preposition is a clause",
+ "Object of a preposition",
+ "Possession modifier",
+ "Postverbal negative particle",
+ "Predicate complement",
+ "Preconjunt",
+ "Predeterminer",
+ "Prefix",
+ "Prepositional modifier",
+ "The relationship between a verb and verbal morpheme",
+ "Particle",
+ "Associative or possessive marker",
+ "Quantifier phrase modifier",
+ "Relative clause modifier",
+ "Complementizer in relative clause",
+ "Ellipsis without a preceding predicate",
+ "Referent",
+ "Remnant",
+ "Reparandum",
+ "Root",
+ "Suffix specifying a unit of number",
+ "Suffix",
+ "Temporal modifier",
+ "Topic marker",
+ "Clause headed by an infinite form of the verb that modifies a noun",
+ "Vocative",
+ "Open clausal complement",
+ "Name suffix",
+ "Name title",
+ "Adverbial phrase modifier",
+ "Causative auxiliary",
+ "Helper auxiliary",
+ "Rentaishi (Prenominal modifier)",
+ "Foreign words",
+ "Keyword",
+ "List for chains of comparable items",
+ "Nominalized clause",
+ "Nominalized clausal subject",
+ "Nominalized clausal passive",
+ "Compound of numeric modifier",
+ "Copula",
+ "Dislocated relation (for fronted/topicalized elements)",
+ "Aspect marker",
+ "Genitive modifier",
+ "Genitive object",
+ "Infinitival modifier",
+ "Measure",
+ "Nominal complement of a noun"
+ ],
"enum": [
"UNKNOWN",
"ABBREV",
@@ -160,123 +788,17 @@
"NCOMP"
],
"description": "The parse label for the token.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Abbreviation modifier",
- "Adjectival complement",
- "Adverbial clause modifier",
- "Adverbial modifier",
- "Adjectival modifier of an NP",
- "Appositional modifier of an NP",
- "Attribute dependent of a copular verb",
- "Auxiliary (non-main) verb",
- "Passive auxiliary",
- "Coordinating conjunction",
- "Clausal complement of a verb or adjective",
- "Conjunct",
- "Clausal subject",
- "Clausal passive subject",
- "Dependency (unable to determine)",
- "Determiner",
- "Discourse",
- "Direct object",
- "Expletive",
- "Goes with (part of a word in a text not well edited)",
- "Indirect object",
- "Marker (word introducing a subordinate clause)",
- "Multi-word expression",
- "Multi-word verbal expression",
- "Negation modifier",
- "Noun compound modifier",
- "Noun phrase used as an adverbial modifier",
- "Nominal subject",
- "Passive nominal subject",
- "Numeric modifier of a noun",
- "Element of compound number",
- "Punctuation mark",
- "Parataxis relation",
- "Participial modifier",
- "The complement of a preposition is a clause",
- "Object of a preposition",
- "Possession modifier",
- "Postverbal negative particle",
- "Predicate complement",
- "Preconjunt",
- "Predeterminer",
- "Prefix",
- "Prepositional modifier",
- "The relationship between a verb and verbal morpheme",
- "Particle",
- "Associative or possessive marker",
- "Quantifier phrase modifier",
- "Relative clause modifier",
- "Complementizer in relative clause",
- "Ellipsis without a preceding predicate",
- "Referent",
- "Remnant",
- "Reparandum",
- "Root",
- "Suffix specifying a unit of number",
- "Suffix",
- "Temporal modifier",
- "Topic marker",
- "Clause headed by an infinite form of the verb that modifies a noun",
- "Vocative",
- "Open clausal complement",
- "Name suffix",
- "Name title",
- "Adverbial phrase modifier",
- "Causative auxiliary",
- "Helper auxiliary",
- "Rentaishi (Prenominal modifier)",
- "Foreign words",
- "Keyword",
- "List for chains of comparable items",
- "Nominalized clause",
- "Nominalized clausal subject",
- "Nominalized clausal passive",
- "Compound of numeric modifier",
- "Copula",
- "Dislocated relation (for fronted/topicalized elements)",
- "Aspect marker",
- "Genitive modifier",
- "Genitive object",
- "Infinitival modifier",
- "Measure",
- "Nominal complement of a noun"
- ]
+ "type": "string"
},
"headTokenIndex": {
- "type": "integer",
"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"
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "DependencyEdge"
- },
- "Token": {
- "id": "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."
- },
- "text": {
- "description": "The token text.",
- "$ref": "TextSpan"
- },
- "dependencyEdge": {
- "$ref": "DependencyEdge",
- "description": "Dependency tree parse for this token."
- },
- "lemma": {
- "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
- "type": "string"
- }
- }
+ "id": "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"
},
"TextSpan": {
"description": "Represents an output piece of text.",
@@ -294,8 +816,59 @@
},
"id": "TextSpan"
},
+ "Token": {
+ "properties": {
+ "partOfSpeech": {
+ "$ref": "PartOfSpeech",
+ "description": "Parts of speech tag for this token."
+ },
+ "text": {
+ "description": "The token text.",
+ "$ref": "TextSpan"
+ },
+ "dependencyEdge": {
+ "$ref": "DependencyEdge",
+ "description": "Dependency tree parse for this token."
+ },
+ "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"
+ },
+ "EntityMention": {
+ "properties": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "EntityMention",
+ "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
+ "type": "object"
+ },
"ClassifyTextResponse": {
- "type": "object",
"properties": {
"categories": {
"description": "Categories representing the input document.",
@@ -306,39 +879,10 @@
}
},
"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": {
- "description": "The type of the entity mention.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Proper name",
- "Common noun (or noun compound)"
- ],
- "enum": [
- "TYPE_UNKNOWN",
- "PROPER",
- "COMMON"
- ]
- },
- "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"
+ "description": "The document classification response message.",
+ "type": "object"
},
"Sentence": {
- "id": "Sentence",
"description": "Represents a sentence in the input document.",
"type": "object",
"properties": {
@@ -347,22 +891,23 @@
"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).",
+ "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"
},
- "magnitude": {
- "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).",
+ "score": {
+ "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).",
"format": "float",
"type": "number"
}
@@ -374,6 +919,12 @@
"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",
@@ -381,13 +932,7 @@
"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": {
"$ref": "Document",
@@ -397,10 +942,22 @@
"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": {
"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",
@@ -416,23 +973,15 @@
"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"
- ]
+ "type": "string"
},
"number": {
+ "enum": [
+ "NUMBER_UNKNOWN",
+ "SINGULAR",
+ "PLURAL",
+ "DUAL"
+ ],
"description": "The grammatical number.",
"type": "string",
"enumDescriptions": [
@@ -440,16 +989,9 @@
"Singular",
"Plural",
"Dual"
- ],
- "enum": [
- "NUMBER_UNKNOWN",
- "SINGULAR",
- "PLURAL",
- "DUAL"
]
},
"voice": {
- "type": "string",
"enumDescriptions": [
"Voice is not applicable in the analyzed language or is not predicted.",
"Active",
@@ -462,7 +1004,8 @@
"CAUSATIVE",
"PASSIVE"
],
- "description": "The grammatical voice."
+ "description": "The grammatical voice.",
+ "type": "string"
},
"aspect": {
"enumDescriptions": [
@@ -481,6 +1024,7 @@
"type": "string"
},
"mood": {
+ "description": "The grammatical mood.",
"type": "string",
"enumDescriptions": [
"Mood is not applicable in the analyzed language or is not predicted.",
@@ -499,10 +1043,25 @@
"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",
@@ -520,23 +1079,7 @@
"AFFIX"
],
"description": "The part of speech tag.",
- "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"
- ]
+ "type": "string"
},
"gender": {
"enumDescriptions": [
@@ -555,6 +1098,13 @@
"type": "string"
},
"person": {
+ "enumDescriptions": [
+ "Person is not applicable in the analyzed language or is not predicted.",
+ "First",
+ "Second",
+ "Third",
+ "Reflexive"
+ ],
"enum": [
"PERSON_UNKNOWN",
"FIRST",
@@ -563,16 +1113,11 @@
"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"
- ]
+ "type": "string"
},
"proper": {
+ "description": "The grammatical properness.",
+ "type": "string",
"enumDescriptions": [
"Proper is not applicable in the analyzed language or is not predicted.",
"Proper",
@@ -582,28 +1127,9 @@
"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": [
@@ -622,11 +1148,26 @@
"Reflexive",
"Relative",
"Vocative"
+ ],
+ "enum": [
+ "CASE_UNKNOWN",
+ "ACCUSATIVE",
+ "ADVERBIAL",
+ "COMPLEMENTIVE",
+ "DATIVE",
+ "GENITIVE",
+ "INSTRUMENTAL",
+ "LOCATIVE",
+ "NOMINATIVE",
+ "OBLIQUE",
+ "PARTITIVE",
+ "PREPOSITIONAL",
+ "REFLEXIVE_CASE",
+ "RELATIVE_CASE",
+ "VOCATIVE"
]
},
"tense": {
- "description": "The grammatical tense.",
- "type": "string",
"enumDescriptions": [
"Tense is not applicable in the analyzed language or is not predicted.",
"Conditional",
@@ -644,9 +1185,13 @@
"PRESENT",
"IMPERFECT",
"PLUPERFECT"
- ]
+ ],
+ "description": "The grammatical tense.",
+ "type": "string"
},
"reciprocity": {
+ "description": "The grammatical reciprocity.",
+ "type": "string",
"enumDescriptions": [
"Reciprocity is not applicable in the analyzed language or is not\npredicted.",
"Reciprocal",
@@ -656,12 +1201,12 @@
"RECIPROCITY_UNKNOWN",
"RECIPROCAL",
"NON_RECIPROCAL"
- ],
- "description": "The grammatical reciprocity.",
- "type": "string"
+ ]
}
},
- "id": "PartOfSpeech"
+ "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",
+ "type": "object"
},
"ClassificationCategory": {
"properties": {
@@ -678,339 +1223,13 @@
"id": "ClassificationCategory",
"description": "Represents a category returned from the text classifier.",
"type": "object"
- },
- "AnalyzeSyntaxRequest": {
- "description": "The syntax 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": {
- "description": "Input document.",
- "$ref": "Document"
- }
- },
- "id": "AnalyzeSyntaxRequest"
- },
- "AnalyzeEntitiesResponse": {
- "description": "The entity 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.",
- "type": "array",
- "items": {
- "$ref": "Entity"
- }
- }
- },
- "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": {
- "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": {
- "description": "The entity type.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Person",
- "Location",
- "Organization",
- "Event",
- "Work of art",
- "Consumer goods",
- "Other types"
- ],
- "enum": [
- "UNKNOWN",
- "PERSON",
- "LOCATION",
- "ORGANIZATION",
- "EVENT",
- "WORK_OF_ART",
- "CONSUMER_GOOD",
- "OTHER"
- ]
- },
- "metadata": {
- "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.",
- "type": "object"
- },
- "salience": {
- "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",
- "type": "number"
- },
- "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."
- }
- }
- },
- "AnnotateTextRequest": {
- "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
- "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."
- },
- "features": {
- "description": "The enabled features.",
- "$ref": "Features"
- }
- },
- "id": "AnnotateTextRequest"
- },
- "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",
- "UTF16",
- "UTF32"
- ],
- "description": "The encoding type used by the API to calculate sentence offsets.",
- "type": "string"
- },
- "document": {
- "$ref": "Document",
- "description": "Input 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": {
- "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": {
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- }
- },
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Status"
- },
- "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": {
- "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": {
- "type": "boolean",
- "description": "Extract entities."
- },
- "classifyText": {
- "description": "Classify the full document into categories.",
- "type": "boolean"
- }
- },
- "id": "Features"
- },
- "Document": {
- "description": "################################################################ #\n\nRepresents the input to API methods.",
- "type": "object",
- "properties": {
- "type": {
- "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
- "type": "string",
- "enumDescriptions": [
- "The content type is not specified.",
- "Plain text",
- "HTML"
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "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"
- },
- "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": {
- "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": {
- "description": "Input document.",
- "$ref": "Document"
- }
- },
- "id": "AnalyzeEntitiesRequest",
- "description": "The entity analysis request message."
- },
- "ClassifyTextRequest": {
- "description": "The document classification request message.",
- "type": "object",
- "properties": {
- "document": {
- "description": "Input document.",
- "$ref": "Document"
- }
- },
- "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"
- }
- }
- },
- "id": "AnalyzeEntitySentimentResponse"
- },
- "AnalyzeSentimentResponse": {
- "description": "The sentiment analysis response message.",
- "type": "object",
- "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"
}
},
+ "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 Natural Language",
"auth": {
"oauth2": {
@@ -1028,224 +1247,5 @@
"ownerDomain": "google.com",
"name": "language",
"batchPath": "batch",
- "title": "Google Cloud Natural Language API",
- "ownerName": "Google",
- "resources": {
- "documents": {
- "methods": {
- "analyzeEntitySentiment": {
- "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions.",
- "request": {
- "$ref": "AnalyzeEntitySentimentRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeEntitySentimentResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/documents:analyzeEntitySentiment",
- "id": "language.documents.analyzeEntitySentiment",
- "path": "v1/documents:analyzeEntitySentiment"
- },
- "analyzeEntities": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/documents:analyzeEntities",
- "path": "v1/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"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
- },
- "analyzeSyntax": {
- "id": "language.documents.analyzeSyntax",
- "path": "v1/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.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeSyntaxResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/documents:analyzeSyntax"
- },
- "annotateText": {
- "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.",
- "request": {
- "$ref": "AnnotateTextRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnnotateTextResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/documents:annotateText",
- "id": "language.documents.annotateText",
- "path": "v1/documents:annotateText"
- },
- "classifyText": {
- "description": "Classifies a document into categories.",
- "request": {
- "$ref": "ClassifyTextRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "ClassifyTextResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1/documents:classifyText",
- "id": "language.documents.classifyText",
- "path": "v1/documents:classifyText"
- },
- "analyzeSentiment": {
- "path": "v1/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": {},
- "flatPath": "v1/documents:analyzeSentiment"
- }
- }
- }
- },
- "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": {
- "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": {
- "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": {
- "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": {
- "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"
- ]
- }
- },
- "version": "v1",
- "baseUrl": "https://language.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
- "servicePath": "",
- "basePath": "",
- "id": "language:v1",
- "documentationLink": "https://cloud.google.com/natural-language/",
- "revision": "20171212",
- "discoveryVersion": "v1"
+ "title": "Google Cloud Natural Language API"
}
diff --git a/language/v1beta1/language-api.json b/language/v1beta1/language-api.json
index e680784..afc04b0 100644
--- a/language/v1beta1/language-api.json
+++ b/language/v1beta1/language-api.json
@@ -1,444 +1,16 @@
{
+ "version": "v1beta1",
+ "baseUrl": "https://language.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "language:v1beta1",
+ "revision": "20171212",
+ "documentationLink": "https://cloud.google.com/natural-language/",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "AnalyzeEntitiesRequest": {
- "description": "The entity 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": "AnalyzeEntitiesRequest"
- },
- "Sentiment": {
- "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
- "type": "object",
- "properties": {
- "polarity": {
- "description": "DEPRECATED FIELD - This field is being deprecated in\nfavor of score. Please refer to our documentation at\nhttps://cloud.google.com/natural-language/docs for more information.",
- "format": "float",
- "type": "number"
- },
- "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"
- },
- "PartOfSpeech": {
- "description": "Represents part of speech information for a token.",
- "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": {
- "enumDescriptions": [
- "Voice is not applicable in the analyzed language or is not predicted.",
- "Active",
- "Causative",
- "Passive"
- ],
- "enum": [
- "VOICE_UNKNOWN",
- "ACTIVE",
- "CAUSATIVE",
- "PASSIVE"
- ],
- "description": "The grammatical voice.",
- "type": "string"
- },
- "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"
- ],
- "description": "The grammatical aspect."
- },
- "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": {
- "enum": [
- "UNKNOWN",
- "ADJ",
- "ADP",
- "ADV",
- "CONJ",
- "DET",
- "NOUN",
- "NUM",
- "PRON",
- "PRT",
- "PUNCT",
- "VERB",
- "X",
- "AFFIX"
- ],
- "description": "The part of speech tag.",
- "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": {
- "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": {
- "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": {
- "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"
- ],
- "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"
- },
- "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"
- }
- },
- "id": "PartOfSpeech"
- },
- "AnalyzeSyntaxRequest": {
- "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": "AnalyzeSyntaxRequest",
- "description": "The syntax analysis request message.",
- "type": "object"
- },
- "AnalyzeSentimentResponse": {
- "id": "AnalyzeSentimentResponse",
- "description": "The sentiment analysis response message.",
- "type": "object",
- "properties": {
- "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": {
- "type": "array",
- "items": {
- "$ref": "Sentence"
- },
- "description": "The sentiment for all the sentences in the document."
- },
- "documentSentiment": {
- "description": "The overall sentiment of the input document.",
- "$ref": "Sentiment"
- }
- }
- },
- "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"
- },
- "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": {
- "type": {
- "description": "The entity type.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Person",
- "Location",
- "Organization",
- "Event",
- "Work of art",
- "Consumer goods",
- "Other types"
- ],
- "enum": [
- "UNKNOWN",
- "PERSON",
- "LOCATION",
- "ORGANIZATION",
- "EVENT",
- "WORK_OF_ART",
- "CONSUMER_GOOD",
- "OTHER"
- ]
- },
- "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."
- },
- "salience": {
- "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",
- "type": "number"
- },
- "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"
- }
- }
- },
"AnalyzeSyntaxResponse": {
"properties": {
"language": {
@@ -464,24 +36,64 @@
"description": "The syntax analysis response message.",
"type": "object"
},
- "AnnotateTextRequest": {
+ "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": {
- "encodingType": {
- "description": "The encoding type used by the API to calculate offsets.",
+ "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": {
+ "enum": [
+ "UNKNOWN",
+ "PERSON",
+ "LOCATION",
+ "ORGANIZATION",
+ "EVENT",
+ "WORK_OF_ART",
+ "CONSUMER_GOOD",
+ "OTHER"
+ ],
+ "description": "The entity type.",
"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"
+ "Unknown",
+ "Person",
+ "Location",
+ "Organization",
+ "Event",
+ "Work of art",
+ "Consumer goods",
+ "Other types"
]
},
+ "metadata": {
+ "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.",
+ "type": "object"
+ },
+ "salience": {
+ "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",
+ "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.",
+ "type": "object",
+ "properties": {
"document": {
"$ref": "Document",
"description": "Input document."
@@ -489,34 +101,30 @@
"features": {
"$ref": "Features",
"description": "The enabled features."
+ },
+ "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."
+ ]
}
},
- "id": "AnnotateTextRequest",
- "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
- "type": "object"
+ "id": "AnnotateTextRequest"
},
"AnnotateTextResponse": {
"description": "The text annotations response message.",
"type": "object",
"properties": {
- "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": {
- "type": "array",
- "items": {
- "$ref": "Sentence"
- },
- "description": "Sentences in the input document. Populated if the user enables\nAnnotateTextRequest.Features.extract_syntax."
- },
- "tokens": {
- "description": "Tokens, along with their syntactic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
- "type": "array",
- "items": {
- "$ref": "Token"
- }
- },
"entities": {
"description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.",
"type": "array",
@@ -527,6 +135,24 @@
"documentSentiment": {
"$ref": "Sentiment",
"description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_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.",
+ "type": "string"
+ },
+ "sentences": {
+ "description": "Sentences in the input document. Populated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
+ "type": "array",
+ "items": {
+ "$ref": "Sentence"
+ }
+ },
+ "tokens": {
+ "description": "Tokens, along with their syntactic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
+ "type": "array",
+ "items": {
+ "$ref": "Token"
+ }
}
},
"id": "AnnotateTextResponse"
@@ -536,12 +162,6 @@
"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",
@@ -549,7 +169,13 @@
"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.",
@@ -562,93 +188,12 @@
"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.",
+ "format": "int32",
+ "type": "integer"
+ },
"label": {
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Abbreviation modifier",
- "Adjectival complement",
- "Adverbial clause modifier",
- "Adverbial modifier",
- "Adjectival modifier of an NP",
- "Appositional modifier of an NP",
- "Attribute dependent of a copular verb",
- "Auxiliary (non-main) verb",
- "Passive auxiliary",
- "Coordinating conjunction",
- "Clausal complement of a verb or adjective",
- "Conjunct",
- "Clausal subject",
- "Clausal passive subject",
- "Dependency (unable to determine)",
- "Determiner",
- "Discourse",
- "Direct object",
- "Expletive",
- "Goes with (part of a word in a text not well edited)",
- "Indirect object",
- "Marker (word introducing a subordinate clause)",
- "Multi-word expression",
- "Multi-word verbal expression",
- "Negation modifier",
- "Noun compound modifier",
- "Noun phrase used as an adverbial modifier",
- "Nominal subject",
- "Passive nominal subject",
- "Numeric modifier of a noun",
- "Element of compound number",
- "Punctuation mark",
- "Parataxis relation",
- "Participial modifier",
- "The complement of a preposition is a clause",
- "Object of a preposition",
- "Possession modifier",
- "Postverbal negative particle",
- "Predicate complement",
- "Preconjunt",
- "Predeterminer",
- "Prefix",
- "Prepositional modifier",
- "The relationship between a verb and verbal morpheme",
- "Particle",
- "Associative or possessive marker",
- "Quantifier phrase modifier",
- "Relative clause modifier",
- "Complementizer in relative clause",
- "Ellipsis without a preceding predicate",
- "Referent",
- "Remnant",
- "Reparandum",
- "Root",
- "Suffix specifying a unit of number",
- "Suffix",
- "Temporal modifier",
- "Topic marker",
- "Clause headed by an infinite form of the verb that modifies a noun",
- "Vocative",
- "Open clausal complement",
- "Name suffix",
- "Name title",
- "Adverbial phrase modifier",
- "Causative auxiliary",
- "Helper auxiliary",
- "Rentaishi (Prenominal modifier)",
- "Foreign words",
- "Keyword",
- "List for chains of comparable items",
- "Nominalized clause",
- "Nominalized clausal subject",
- "Nominalized clausal passive",
- "Compound of numeric modifier",
- "Copula",
- "Dislocated relation (for fronted/topicalized elements)",
- "Aspect marker",
- "Genitive modifier",
- "Genitive object",
- "Infinitival modifier",
- "Measure",
- "Nominal complement of a noun"
- ],
"enum": [
"UNKNOWN",
"ABBREV",
@@ -734,23 +279,124 @@
"MES",
"NCOMP"
],
- "description": "The parse label for the token."
- },
- "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"
+ "description": "The parse label for the token.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown",
+ "Abbreviation modifier",
+ "Adjectival complement",
+ "Adverbial clause modifier",
+ "Adverbial modifier",
+ "Adjectival modifier of an NP",
+ "Appositional modifier of an NP",
+ "Attribute dependent of a copular verb",
+ "Auxiliary (non-main) verb",
+ "Passive auxiliary",
+ "Coordinating conjunction",
+ "Clausal complement of a verb or adjective",
+ "Conjunct",
+ "Clausal subject",
+ "Clausal passive subject",
+ "Dependency (unable to determine)",
+ "Determiner",
+ "Discourse",
+ "Direct object",
+ "Expletive",
+ "Goes with (part of a word in a text not well edited)",
+ "Indirect object",
+ "Marker (word introducing a subordinate clause)",
+ "Multi-word expression",
+ "Multi-word verbal expression",
+ "Negation modifier",
+ "Noun compound modifier",
+ "Noun phrase used as an adverbial modifier",
+ "Nominal subject",
+ "Passive nominal subject",
+ "Numeric modifier of a noun",
+ "Element of compound number",
+ "Punctuation mark",
+ "Parataxis relation",
+ "Participial modifier",
+ "The complement of a preposition is a clause",
+ "Object of a preposition",
+ "Possession modifier",
+ "Postverbal negative particle",
+ "Predicate complement",
+ "Preconjunt",
+ "Predeterminer",
+ "Prefix",
+ "Prepositional modifier",
+ "The relationship between a verb and verbal morpheme",
+ "Particle",
+ "Associative or possessive marker",
+ "Quantifier phrase modifier",
+ "Relative clause modifier",
+ "Complementizer in relative clause",
+ "Ellipsis without a preceding predicate",
+ "Referent",
+ "Remnant",
+ "Reparandum",
+ "Root",
+ "Suffix specifying a unit of number",
+ "Suffix",
+ "Temporal modifier",
+ "Topic marker",
+ "Clause headed by an infinite form of the verb that modifies a noun",
+ "Vocative",
+ "Open clausal complement",
+ "Name suffix",
+ "Name title",
+ "Adverbial phrase modifier",
+ "Causative auxiliary",
+ "Helper auxiliary",
+ "Rentaishi (Prenominal modifier)",
+ "Foreign words",
+ "Keyword",
+ "List for chains of comparable items",
+ "Nominalized clause",
+ "Nominalized clausal subject",
+ "Nominalized clausal passive",
+ "Compound of numeric modifier",
+ "Copula",
+ "Dislocated relation (for fronted/topicalized elements)",
+ "Aspect marker",
+ "Genitive modifier",
+ "Genitive object",
+ "Infinitival modifier",
+ "Measure",
+ "Nominal complement of a noun"
+ ]
}
},
"id": "DependencyEdge"
},
+ "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "content": {
+ "description": "The content of the output text.",
+ "type": "string"
+ }
+ },
+ "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."
+ },
"text": {
- "$ref": "TextSpan",
- "description": "The token text."
+ "description": "The token text.",
+ "$ref": "TextSpan"
},
"dependencyEdge": {
"description": "Dependency tree parse for this token.",
@@ -759,41 +405,23 @@
"lemma": {
"description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
"type": "string"
- },
- "partOfSpeech": {
- "$ref": "PartOfSpeech",
- "description": "Parts of speech tag for this token."
}
},
"id": "Token"
},
- "TextSpan": {
- "type": "object",
- "properties": {
- "content": {
- "description": "The content of the output text.",
- "type": "string"
- },
- "beginOffset": {
- "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"
- }
- },
- "id": "TextSpan",
- "description": "Represents an output piece of text."
- },
"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": {
@@ -806,9 +434,7 @@
"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"
},
"EntityMention": {
"description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
@@ -839,6 +465,10 @@
"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": {
+ "description": "Extract entities.",
+ "type": "boolean"
+ },
"extractSyntax": {
"description": "Extract syntax information.",
"type": "boolean"
@@ -846,10 +476,6 @@
"extractDocumentSentiment": {
"description": "Extract document-level sentiment.",
"type": "boolean"
- },
- "extractEntities": {
- "description": "Extract entities.",
- "type": "boolean"
}
},
"id": "Features"
@@ -858,6 +484,10 @@
"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"
@@ -879,28 +509,407 @@
"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"
},
"Sentence": {
- "description": "Represents a sentence in the input document.",
- "type": "object",
"properties": {
"text": {
"description": "The sentence text.",
"$ref": "TextSpan"
},
"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"
}
},
- "id": "Sentence"
+ "id": "Sentence",
+ "description": "Represents a sentence in the input document.",
+ "type": "object"
+ },
+ "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": {
+ "$ref": "Document",
+ "description": "Input document."
+ }
+ },
+ "id": "AnalyzeEntitiesRequest"
+ },
+ "Sentiment": {
+ "properties": {
+ "polarity": {
+ "description": "DEPRECATED FIELD - This field is being deprecated in\nfavor of score. Please refer to our documentation at\nhttps://cloud.google.com/natural-language/docs for more information.",
+ "format": "float",
+ "type": "number"
+ },
+ "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"
+ },
+ "PartOfSpeech": {
+ "properties": {
+ "form": {
+ "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"
+ ],
+ "enum": [
+ "FORM_UNKNOWN",
+ "ADNOMIAL",
+ "AUXILIARY",
+ "COMPLEMENTIZER",
+ "FINAL_ENDING",
+ "GERUND",
+ "REALIS",
+ "IRREALIS",
+ "SHORT",
+ "LONG",
+ "ORDER",
+ "SPECIFIC"
+ ]
+ },
+ "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": {
+ "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": {
+ "enum": [
+ "ASPECT_UNKNOWN",
+ "PERFECTIVE",
+ "IMPERFECTIVE",
+ "PROGRESSIVE"
+ ],
+ "description": "The grammatical aspect.",
+ "type": "string",
+ "enumDescriptions": [
+ "Aspect is not applicable in the analyzed language or is not predicted.",
+ "Perfective",
+ "Imperfective",
+ "Progressive"
+ ]
+ },
+ "mood": {
+ "enum": [
+ "MOOD_UNKNOWN",
+ "CONDITIONAL_MOOD",
+ "IMPERATIVE",
+ "INDICATIVE",
+ "INTERROGATIVE",
+ "JUSSIVE",
+ "SUBJUNCTIVE"
+ ],
+ "description": "The grammatical mood.",
+ "type": "string",
+ "enumDescriptions": [
+ "Mood is not applicable in the analyzed language or is not predicted.",
+ "Conditional",
+ "Imperative",
+ "Indicative",
+ "Interrogative",
+ "Jussive",
+ "Subjunctive"
+ ]
+ },
+ "tag": {
+ "enum": [
+ "UNKNOWN",
+ "ADJ",
+ "ADP",
+ "ADV",
+ "CONJ",
+ "DET",
+ "NOUN",
+ "NUM",
+ "PRON",
+ "PRT",
+ "PUNCT",
+ "VERB",
+ "X",
+ "AFFIX"
+ ],
+ "description": "The part of speech tag.",
+ "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": [
+ "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.",
+ "type": "string"
+ },
+ "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": {
+ "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": {
+ "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"
+ ],
+ "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"
+ },
+ "tense": {
+ "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"
+ ],
+ "enum": [
+ "TENSE_UNKNOWN",
+ "CONDITIONAL_TENSE",
+ "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.",
+ "type": "object"
+ },
+ "AnalyzeSyntaxRequest": {
+ "properties": {
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
+ },
+ "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"
+ ]
+ }
+ },
+ "id": "AnalyzeSyntaxRequest",
+ "description": "The syntax analysis request message.",
+ "type": "object"
+ },
+ "AnalyzeSentimentResponse": {
+ "description": "The sentiment analysis response message.",
+ "type": "object",
+ "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"
+ },
+ "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"
}
},
"icons": {
@@ -930,25 +939,6 @@
"resources": {
"documents": {
"methods": {
- "annotateText": {
- "id": "language.documents.annotateText",
- "path": "v1beta1/documents:annotateText",
- "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.",
- "request": {
- "$ref": "AnnotateTextRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnnotateTextResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta1/documents:annotateText"
- },
"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": {
@@ -969,42 +959,61 @@
"id": "language.documents.analyzeEntities"
},
"analyzeSyntax": {
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "AnalyzeSyntaxResponse"
},
- "parameters": {},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {},
"flatPath": "v1beta1/documents:analyzeSyntax",
- "id": "language.documents.analyzeSyntax",
"path": "v1beta1/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"
- },
- "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties."
+ }
},
"analyzeSentiment": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeSentimentResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
"flatPath": "v1beta1/documents:analyzeSentiment",
- "id": "language.documents.analyzeSentiment",
"path": "v1beta1/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": {}
+ },
+ "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": "v1beta1/documents:annotateText",
+ "path": "v1beta1/documents:annotateText",
+ "id": "language.documents.annotateText"
}
}
}
@@ -1016,28 +1025,22 @@
"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",
+ "default": "true",
"location": "query"
},
- "uploadType": {
+ "fields": {
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "callback": {
- "description": "JSONP",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
"$.xgafv": {
- "location": "query",
"enum": [
"1",
"2"
@@ -1047,7 +1050,13 @@
"enumDescriptions": [
"v1 error format",
"v2 error format"
- ]
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"alt": {
"enum": [
@@ -1071,9 +1080,9 @@
"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"
+ "type": "string",
+ "location": "query"
},
"quotaUser": {
"location": "query",
@@ -1087,23 +1096,14 @@
"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",
"description": "OAuth bearer token.",
"type": "string"
}
- },
- "version": "v1beta1",
- "baseUrl": "https://language.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
- "servicePath": "",
- "basePath": "",
- "revision": "20171212",
- "documentationLink": "https://cloud.google.com/natural-language/",
- "id": "language:v1beta1"
+ }
}
diff --git a/language/v1beta2/language-api.json b/language/v1beta2/language-api.json
index be62d0b..9baeccc 100644
--- a/language/v1beta2/language-api.json
+++ b/language/v1beta2/language-api.json
@@ -1,5 +1,38 @@
{
+ "basePath": "",
+ "id": "language:v1beta2",
+ "documentationLink": "https://cloud.google.com/natural-language/",
+ "revision": "20171212",
+ "discoveryVersion": "v1",
+ "version_module": true,
"schemas": {
+ "AnalyzeEntitiesRequest": {
+ "description": "The entity 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": {
+ "description": "Input document.",
+ "$ref": "Document"
+ }
+ },
+ "id": "AnalyzeEntitiesRequest"
+ },
"ClassifyTextRequest": {
"description": "The document classification request message.",
"type": "object",
@@ -12,28 +45,29 @@
"id": "ClassifyTextRequest"
},
"AnalyzeEntitySentimentResponse": {
- "id": "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": {
- "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"
},
"AnalyzeSentimentResponse": {
- "id": "AnalyzeSentimentResponse",
- "description": "The sentiment analysis response message.",
- "type": "object",
"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"
@@ -44,53 +78,41 @@
"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"
- },
- "description": "Sentences in the input document."
+ }
},
"tokens": {
+ "description": "Tokens, along with their syntactic information, in the input document.",
"type": "array",
"items": {
"$ref": "Token"
- },
- "description": "Tokens, along with their syntactic information, in the input document."
+ }
}
},
- "id": "AnalyzeSyntaxResponse"
+ "id": "AnalyzeSyntaxResponse",
+ "description": "The syntax analysis response message.",
+ "type": "object"
},
"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": {
- "type": "array",
- "items": {
- "$ref": "Entity"
- },
- "description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities."
- },
"sentences": {
"description": "Sentences in the input document. Populated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
"type": "array",
@@ -99,11 +121,11 @@
}
},
"tokens": {
+ "description": "Tokens, along with their syntactic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
"type": "array",
"items": {
"$ref": "Token"
- },
- "description": "Tokens, along with their syntactic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_syntax."
+ }
},
"categories": {
"description": "Categories identified in the input document.",
@@ -115,19 +137,23 @@
"documentSentiment": {
"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.",
+ "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"
},
"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.",
- "format": "int32",
- "type": "integer"
- },
"label": {
"enumDescriptions": [
"Unknown",
@@ -301,9 +327,16 @@
],
"description": "The parse label for the token.",
"type": "string"
+ },
+ "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"
+ "id": "DependencyEdge",
+ "description": "Represents dependency parse tree information for a token.",
+ "type": "object"
},
"TextSpan": {
"description": "Represents an output piece of text.",
@@ -315,8 +348,8 @@
"type": "integer"
},
"content": {
- "type": "string",
- "description": "The content of the output text."
+ "description": "The content of the output text.",
+ "type": "string"
}
},
"id": "TextSpan"
@@ -330,12 +363,12 @@
"$ref": "PartOfSpeech"
},
"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."
},
"lemma": {
"description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
@@ -344,36 +377,9 @@
},
"id": "Token"
},
- "EntityMention": {
- "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."
- },
- "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"
- }
- },
- "id": "EntityMention",
- "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported."
- },
"ClassifyTextResponse": {
+ "description": "The document classification response message.",
+ "type": "object",
"properties": {
"categories": {
"description": "Categories representing the input document.",
@@ -383,26 +389,55 @@
}
}
},
- "id": "ClassifyTextResponse",
- "description": "The document classification response message.",
- "type": "object"
+ "id": "ClassifyTextResponse"
},
- "Sentence": {
- "description": "Represents a sentence in the input document.",
+ "EntityMention": {
+ "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
"type": "object",
"properties": {
+ "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"
+ },
"text": {
"$ref": "TextSpan",
- "description": "The sentence text."
+ "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)"
+ ]
+ }
+ },
+ "id": "EntityMention"
+ },
+ "Sentence": {
+ "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"
+ "id": "Sentence",
+ "description": "Represents a sentence in the input document.",
+ "type": "object"
},
"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).",
@@ -415,13 +450,9 @@
"type": "number"
}
},
- "id": "Sentiment",
- "description": "Represents the feeling associated with the entire text or entities in\nthe text.",
- "type": "object"
+ "id": "Sentiment"
},
"AnalyzeEntitySentimentRequest": {
- "description": "The entity-level sentiment analysis request message.",
- "type": "object",
"properties": {
"encodingType": {
"enumDescriptions": [
@@ -444,16 +475,86 @@
"$ref": "Document"
}
},
- "id": "AnalyzeEntitySentimentRequest"
+ "id": "AnalyzeEntitySentimentRequest",
+ "description": "The entity-level sentiment analysis request message.",
+ "type": "object"
},
"PartOfSpeech": {
"description": "Represents part of speech information for a token.",
"type": "object",
"properties": {
- "proper": {
- "description": "The grammatical properness.",
+ "tag": {
+ "enum": [
+ "UNKNOWN",
+ "ADJ",
+ "ADP",
+ "ADV",
+ "CONJ",
+ "DET",
+ "NOUN",
+ "NUM",
+ "PRON",
+ "PRT",
+ "PUNCT",
+ "VERB",
+ "X",
+ "AFFIX"
+ ],
+ "description": "The part of speech tag.",
"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": [
+ "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.",
+ "type": "string"
+ },
+ "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"
@@ -462,7 +563,9 @@
"PROPER_UNKNOWN",
"PROPER",
"NOT_PROPER"
- ]
+ ],
+ "description": "The grammatical properness.",
+ "type": "string"
},
"case": {
"enumDescriptions": [
@@ -503,8 +606,6 @@
"type": "string"
},
"tense": {
- "description": "The grammatical tense.",
- "type": "string",
"enumDescriptions": [
"Tense is not applicable in the analyzed language or is not predicted.",
"Conditional",
@@ -522,21 +623,23 @@
"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",
- "enumDescriptions": [
- "Reciprocity is not applicable in the analyzed language or is not\npredicted.",
- "Reciprocal",
- "Non-reciprocal"
- ]
+ "type": "string"
},
"form": {
"enumDescriptions": [
@@ -571,6 +674,12 @@
"type": "string"
},
"number": {
+ "enum": [
+ "NUMBER_UNKNOWN",
+ "SINGULAR",
+ "PLURAL",
+ "DUAL"
+ ],
"description": "The grammatical number.",
"type": "string",
"enumDescriptions": [
@@ -578,12 +687,6 @@
"Singular",
"Plural",
"Dual"
- ],
- "enum": [
- "NUMBER_UNKNOWN",
- "SINGULAR",
- "PLURAL",
- "DUAL"
]
},
"voice": {
@@ -619,6 +722,8 @@
"type": "string"
},
"mood": {
+ "description": "The grammatical mood.",
+ "type": "string",
"enumDescriptions": [
"Mood is not applicable in the analyzed language or is not predicted.",
"Conditional",
@@ -636,84 +741,14 @@
"INTERROGATIVE",
"JUSSIVE",
"SUBJUNCTIVE"
- ],
- "description": "The grammatical mood.",
- "type": "string"
- },
- "tag": {
- "description": "The part of speech tag.",
- "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"
- ],
- "enum": [
- "UNKNOWN",
- "ADJ",
- "ADP",
- "ADV",
- "CONJ",
- "DET",
- "NOUN",
- "NUM",
- "PRON",
- "PRT",
- "PUNCT",
- "VERB",
- "X",
- "AFFIX"
]
- },
- "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": {
- "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"
- ],
- "description": "The grammatical person."
}
},
"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.",
@@ -725,12 +760,9 @@
"type": "string"
}
},
- "id": "ClassificationCategory",
- "description": "Represents a category returned from the text classifier.",
- "type": "object"
+ "id": "ClassificationCategory"
},
"AnalyzeSyntaxRequest": {
- "id": "AnalyzeSyntaxRequest",
"description": "The syntax analysis request message.",
"type": "object",
"properties": {
@@ -754,46 +786,32 @@
"description": "The encoding type used by the API to calculate offsets.",
"type": "string"
}
- }
+ },
+ "id": "AnalyzeSyntaxRequest"
},
"AnalyzeEntitiesResponse": {
- "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.",
"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."
+ "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",
"properties": {
- "name": {
- "description": "The representative name for the entity.",
- "type": "string"
- },
"type": {
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Person",
- "Location",
- "Organization",
- "Event",
- "Work of art",
- "Consumer goods",
- "Other types"
- ],
"enum": [
"UNKNOWN",
"PERSON",
@@ -804,7 +822,18 @@
"CONSUMER_GOOD",
"OTHER"
],
- "description": "The entity type."
+ "description": "The entity type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown",
+ "Person",
+ "Location",
+ "Organization",
+ "Event",
+ "Work of art",
+ "Consumer goods",
+ "Other types"
+ ]
},
"metadata": {
"additionalProperties": {
@@ -828,13 +857,15 @@
"items": {
"$ref": "EntityMention"
}
+ },
+ "name": {
+ "description": "The representative name for the entity.",
+ "type": "string"
}
},
"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.",
- "type": "object",
"properties": {
"encodingType": {
"enum": [
@@ -857,23 +888,19 @@
"description": "Input document."
},
"features": {
- "$ref": "Features",
- "description": "The enabled features."
+ "description": "The enabled features.",
+ "$ref": "Features"
}
},
- "id": "AnnotateTextRequest"
+ "id": "AnnotateTextRequest",
+ "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
+ "type": "object"
},
"AnalyzeSentimentRequest": {
"description": "The sentiment analysis 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": [
@@ -881,19 +908,22 @@
"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."
+ "description": "Input document.",
+ "$ref": "Document"
}
},
"id": "AnalyzeSentimentRequest"
},
"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.",
@@ -911,24 +941,19 @@
}
},
"code": {
- "type": "integer",
"description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32"
+ "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"
},
"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": {
- "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"
- },
"extractSyntax": {
"description": "Extract syntax information.",
"type": "boolean"
@@ -940,6 +965,14 @@
"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"
@@ -948,6 +981,24 @@
"description": "################################################################ #\n\nRepresents the input to API methods.",
"type": "object",
"properties": {
+ "type": {
+ "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",
+ "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"
@@ -955,59 +1006,14 @@
"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": {
- "type": "string",
- "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."
- },
- "content": {
- "description": "The content of the input in string format.",
- "type": "string"
}
},
"id": "Document"
- },
- "AnalyzeEntitiesRequest": {
- "description": "The entity 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": "AnalyzeEntitiesRequest"
}
},
"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",
@@ -1032,68 +1038,45 @@
"resources": {
"documents": {
"methods": {
- "classifyText": {
- "response": {
- "$ref": "ClassifyTextResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta2/documents:classifyText",
- "path": "v1beta2/documents:classifyText",
- "id": "language.documents.classifyText",
- "description": "Classifies a document into categories.",
- "request": {
- "$ref": "ClassifyTextRequest"
- }
- },
"analyzeSentiment": {
+ "path": "v1beta2/documents:analyzeSentiment",
+ "id": "language.documents.analyzeSentiment",
+ "description": "Analyzes the sentiment of the provided text.",
"request": {
"$ref": "AnalyzeSentimentRequest"
},
- "description": "Analyzes the sentiment of the provided text.",
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "AnalyzeSentimentResponse"
},
- "parameters": {},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta2/documents:analyzeSentiment",
- "id": "language.documents.analyzeSentiment",
- "path": "v1beta2/documents:analyzeSentiment"
+ "parameters": {},
+ "flatPath": "v1beta2/documents:analyzeSentiment"
},
"analyzeEntitySentiment": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeEntitySentimentResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-language",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta2/documents:analyzeEntitySentiment",
- "id": "language.documents.analyzeEntitySentiment",
- "path": "v1beta2/documents:analyzeEntitySentiment",
+ "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions.",
"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"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1beta2/documents:analyzeEntitySentiment",
+ "path": "v1beta2/documents:analyzeEntitySentiment",
+ "id": "language.documents.analyzeEntitySentiment"
},
"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"
},
@@ -1106,26 +1089,30 @@
"parameters": {},
"flatPath": "v1beta2/documents:analyzeEntities",
"path": "v1beta2/documents:analyzeEntities",
- "id": "language.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"
+ }
},
"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"
},
"parameterOrder": [],
"httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-language",
"https://www.googleapis.com/auth/cloud-platform"
],
- "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": {
"response": {
@@ -1145,21 +1132,40 @@
"$ref": "AnnotateTextRequest"
},
"description": "A convenience method that provides all syntax, sentiment, entity, and\nclassification features in one call."
+ },
+ "classifyText": {
+ "request": {
+ "$ref": "ClassifyTextRequest"
+ },
+ "description": "Classifies a document into categories.",
+ "response": {
+ "$ref": "ClassifyTextResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-language",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/documents:classifyText",
+ "path": "v1beta2/documents:classifyText",
+ "id": "language.documents.classifyText"
}
}
}
},
"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",
@@ -1167,13 +1173,8 @@
"type": "string"
},
"fields": {
- "type": "string",
"location": "query",
- "description": "Selector specifying which fields to include in a partial response."
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"$.xgafv": {
@@ -1189,6 +1190,11 @@
"description": "V1 error format.",
"type": "string"
},
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
"alt": {
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -1205,16 +1211,16 @@
],
"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"
},
+ "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",
@@ -1226,26 +1232,20 @@
"type": "boolean",
"default": "true"
},
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
"oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
}
},
"version": "v1beta2",
"baseUrl": "https://language.googleapis.com/",
- "servicePath": "",
- "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
"kind": "discovery#restDescription",
- "basePath": "",
- "revision": "20171212",
- "documentationLink": "https://cloud.google.com/natural-language/",
- "id": "language:v1beta2",
- "discoveryVersion": "v1",
- "version_module": true
+ "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.",
+ "servicePath": ""
}
diff --git a/logging/v2/logging-api.json b/logging/v2/logging-api.json
index 4a60437..9e3c740 100644
--- a/logging/v2/logging-api.json
+++ b/logging/v2/logging-api.json
@@ -1,44 +1,52 @@
{
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Stackdriver Logging API",
"ownerName": "Google",
"resources": {
- "monitoredResourceDescriptors": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListMonitoredResourceDescriptorsResponse"
- },
- "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/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"
- }
- },
- "flatPath": "v2/monitoredResourceDescriptors",
- "path": "v2/monitoredResourceDescriptors",
- "id": "logging.monitoredResourceDescriptors.list",
- "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging."
- }
- }
- },
- "organizations": {
+ "projects": {
"resources": {
"logs": {
"methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "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": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/logs",
+ "id": "logging.projects.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"
@@ -53,195 +61,22 @@
],
"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",
- "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."
+ "pattern": "^projects/[^/]+/logs/[^/]+$",
+ "location": "path"
}
},
- "flatPath": "v2/organizations/{organizationsId}/logs/{logsId}",
+ "flatPath": "v2/projects/{projectsId}/logs/{logsId}",
"path": "v2/{+logName}",
- "id": "logging.organizations.logs.delete",
+ "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."
- },
- "list": {
- "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.",
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "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": "^organizations/[^/]+$"
- }
- },
- "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"
- ]
}
}
},
"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": {
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/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\"."
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.organizations.sinks.get",
- "description": "Gets a sink."
- },
- "patch": {
- "httpMethod": "PATCH",
- "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": "^organizations/[^/]+/sinks/[^/]+$"
- },
- "uniqueWriterIdentity": {
- "type": "boolean",
- "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."
- },
- "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}",
- "id": "logging.organizations.sinks.patch",
- "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."
- },
- "update": {
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "sinkName": {
- "required": true,
- "type": "string",
- "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\"."
- },
- "uniqueWriterIdentity": {
- "type": "boolean",
- "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."
- },
- "updateMask": {
- "type": "string",
- "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"
- }
- },
- "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",
- "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."
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "sinkName": {
- "required": true,
- "type": "string",
- "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\"."
- }
- },
- "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": {
"response": {
"$ref": "ListSinksResponse"
@@ -251,11 +86,6 @@
],
"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.",
@@ -267,7 +97,12 @@
"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/[^/]+$"
+ "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"
}
},
"scopes": [
@@ -276,9 +111,9 @@
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read"
],
- "flatPath": "v2/organizations/{organizationsId}/sinks",
+ "flatPath": "v2/projects/{projectsId}/sinks",
"path": "v2/{+parent}/sinks",
- "id": "logging.organizations.sinks.list",
+ "id": "logging.projects.sinks.list",
"description": "Lists sinks."
},
"create": {
@@ -286,559 +121,37 @@
"$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": {
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "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\"."
- },
- "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",
- "id": "logging.organizations.sinks.create",
- "path": "v2/{+parent}/sinks"
- }
- }
- },
- "exclusions": {
- "methods": {
- "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": {
- "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": {
- "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/[^/]+$"
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.organizations.exclusions.list",
- "description": "Lists all the exclusions in a parent resource."
- },
- "get": {
- "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}",
- "path": "v2/{+name}",
- "id": "logging.organizations.exclusions.get",
- "description": "Gets the description of an exclusion."
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "LogExclusion"
- },
- "parameters": {
- "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": "^organizations/[^/]+/exclusions/[^/]+$"
- },
- "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/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": {
- "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": "^organizations/[^/]+$"
- }
- },
- "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"
- }
- },
- "delete": {
- "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
- "id": "logging.organizations.exclusions.delete",
- "path": "v2/{+name}",
- "description": "Deletes an exclusion.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ]
- }
- }
- }
- }
- },
- "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": "v2/entries:list",
- "id": "logging.entries.list",
- "path": "v2/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": "v2/entries: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"
- }
- }
- }
- },
- "sinks": {
- "methods": {
- "delete": {
- "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.",
- "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": "^[^/]+/[^/]+/sinks/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ]
- },
- "list": {
- "flatPath": "v2/{v2Id}/{v2Id1}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.sinks.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": {
- "required": true,
- "type": "string",
- "pattern": "^[^/]+/[^/]+$",
- "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"
- },
- "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": {
- "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"
- }
- }
- },
- "get": {
- "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}",
- "id": "logging.sinks.get",
- "path": "v2/{+sinkName}",
- "description": "Gets a sink.",
- "httpMethod": "GET",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "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": "^[^/]+/[^/]+/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"
- ]
- },
- "update": {
- "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": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "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": "^[^/]+/[^/]+/sinks/[^/]+$"
- },
- "uniqueWriterIdentity": {
- "type": "boolean",
- "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."
- },
- "updateMask": {
- "type": "string",
- "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"
- }
- },
- "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.sinks.update"
- },
- "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": {
- "required": true,
- "type": "string",
- "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\"."
- },
- "uniqueWriterIdentity": {
- "type": "boolean",
- "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."
- }
- },
- "flatPath": "v2/{v2Id}/{v2Id1}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.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"
- }
- }
- }
- },
- "logs": {
- "methods": {
- "list": {
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameters": {
- "parent": {
- "required": true,
- "type": "string",
- "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"
- },
- "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"
- }
- },
- "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"
- },
- "delete": {
- "flatPath": "v2/{v2Id}/{v2Id1}/logs/{logsId}",
- "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.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "logName": {
- "required": true,
- "type": "string",
- "pattern": "^[^/]+/[^/]+/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"
- ]
- }
- }
- },
- "projects": {
- "resources": {
- "logs": {
- "methods": {
- "list": {
- "flatPath": "v2/projects/{projectsId}/logs",
- "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.",
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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": {
- "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 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",
- "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"
- }
- },
- "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"
- ]
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "logName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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": "^projects/[^/]+/logs/[^/]+$"
+ "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"
],
- "flatPath": "v2/projects/{projectsId}/logs/{logsId}",
- "id": "logging.projects.logs.delete",
- "path": "v2/{+logName}",
- "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": {
+ "flatPath": "v2/projects/{projectsId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.projects.sinks.create"
+ },
"get": {
+ "description": "Gets a sink.",
"response": {
"$ref": "LogSink"
},
@@ -846,30 +159,26 @@
"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}",
"path": "v2/{+sinkName}",
- "id": "logging.projects.sinks.get",
- "description": "Gets a sink."
+ "id": "logging.projects.sinks.get"
},
"patch": {
- "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.projects.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"
@@ -894,19 +203,29 @@
"pattern": "^projects/[^/]+/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"
+ "type": "boolean",
+ "location": "query"
},
"updateMask": {
- "type": "string",
- "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"
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
}
- }
+ },
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.projects.sinks.patch"
},
"update": {
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.projects.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"
},
@@ -914,37 +233,30 @@
"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"
- ],
- "parameters": {
- "sinkName": {
- "required": true,
- "type": "string",
- "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\"."
- },
- "uniqueWriterIdentity": {
- "type": "boolean",
- "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."
- },
- "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/projects/{projectsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.projects.sinks.update",
- "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"
- }
+ ]
},
"delete": {
"flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
@@ -971,85 +283,15 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
]
- },
- "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": {
- "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": "^projects/[^/]+$"
- }
- },
- "flatPath": "v2/projects/{projectsId}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.projects.sinks.list"
- },
- "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": "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."
}
}
},
"exclusions": {
"methods": {
"list": {
+ "flatPath": "v2/projects/{projectsId}/exclusions",
+ "path": "v2/{+parent}/exclusions",
+ "id": "logging.projects.exclusions.list",
"description": "Lists all the exclusions in a parent resource.",
"response": {
"$ref": "ListExclusionsResponse"
@@ -1059,23 +301,23 @@
],
"httpMethod": "GET",
"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": "^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": {
- "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"
+ "type": "integer",
+ "location": "query"
+ },
+ "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": "^projects/[^/]+$"
}
},
"scopes": [
@@ -1083,75 +325,76 @@
"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",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.projects.exclusions.list"
+ ]
},
"get": {
"description": "Gets the description of an exclusion.",
- "response": {
- "$ref": "LogExclusion"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "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": "^projects/[^/]+/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"
],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "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\"."
- }
- },
"flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.projects.exclusions.get"
+ "id": "logging.projects.exclusions.get",
+ "path": "v2/{+name}"
},
"patch": {
- "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.projects.exclusions.patch",
+ "description": "Changes one or more properties of an existing exclusion.",
"request": {
"$ref": "LogExclusion"
},
- "description": "Changes one or more properties of an existing exclusion.",
- "response": {
- "$ref": "LogExclusion"
- },
+ "httpMethod": "PATCH",
"parameterOrder": [
"name"
],
- "httpMethod": "PATCH",
- "parameters": {
- "updateMask": {
- "type": "string",
- "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"
- },
- "name": {
- "required": true,
- "type": "string",
- "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\"."
- }
+ "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": {
+ "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": "^projects/[^/]+/exclusions/[^/]+$"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
+ "id": "logging.projects.exclusions.patch",
+ "path": "v2/{+name}"
},
"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"
+ },
"response": {
"$ref": "LogExclusion"
},
@@ -1174,95 +417,64 @@
},
"flatPath": "v2/projects/{projectsId}/exclusions",
"path": "v2/{+parent}/exclusions",
- "id": "logging.projects.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"
- }
+ "id": "logging.projects.exclusions.create"
},
"delete": {
- "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
- "id": "logging.projects.exclusions.delete",
- "path": "v2/{+name}",
- "description": "Deletes an exclusion.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Empty"
},
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/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\"."
- }
- },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
- ]
+ ],
+ "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": "^projects/[^/]+/exclusions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.projects.exclusions.delete",
+ "description": "Deletes an exclusion."
}
}
},
"metrics": {
"methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "metricName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "metricName": {
- "location": "path",
- "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metrics/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2/{+metricName}",
- "id": "logging.projects.metrics.delete",
- "description": "Deletes a logs-based metric."
- },
"list": {
"httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
"response": {
"$ref": "ListLogMetricsResponse"
},
+ "parameterOrder": [
+ "parent"
+ ],
"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": {
+ "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n"
- },
- "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": {
- "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"
+ "location": "path"
}
},
"scopes": [
@@ -1285,6 +497,12 @@
"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",
@@ -1294,12 +512,6 @@
"pattern": "^projects/[^/]+/metrics/[^/]+$"
}
},
- "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}/metrics/{metricsId}",
"path": "v2/{+metricName}",
"id": "logging.projects.metrics.get"
@@ -1335,34 +547,61 @@
"description": "Creates or updates a logs-based metric."
},
"create": {
- "response": {
+ "request": {
"$ref": "LogMetric"
},
+ "description": "Creates a logs-based metric.",
+ "httpMethod": "POST",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "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/[^/]+$"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.write"
],
+ "flatPath": "v2/projects/{projectsId}/metrics",
+ "id": "logging.projects.metrics.create",
+ "path": "v2/{+parent}/metrics"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "httpMethod": "DELETE",
"parameters": {
- "parent": {
+ "metricName": {
+ "location": "path",
+ "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
"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."
+ "pattern": "^projects/[^/]+/metrics/[^/]+$"
}
},
- "flatPath": "v2/projects/{projectsId}/metrics",
- "path": "v2/{+parent}/metrics",
- "id": "logging.projects.metrics.create",
- "description": "Creates a logs-based metric.",
- "request": {
- "$ref": "LogMetric"
- }
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2/{+metricName}",
+ "id": "logging.projects.metrics.delete",
+ "description": "Deletes a logs-based metric."
}
}
}
@@ -1370,22 +609,211 @@
},
"billingAccounts": {
"resources": {
- "logs": {
+ "exclusions": {
"methods": {
+ "delete": {
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.billingAccounts.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": {
+ "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"
+ }
+ }
+ },
"list": {
- "httpMethod": "GET",
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions",
+ "path": "v2/{+parent}/exclusions",
+ "id": "logging.billingAccounts.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": {
+ "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": "^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"
+ }
+ }
+ },
+ "get": {
+ "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": {
+ "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": "^billingAccounts/[^/]+/exclusions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.billingAccounts.exclusions.get",
+ "description": "Gets the description of an exclusion."
+ },
+ "patch": {
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.billingAccounts.exclusions.patch",
+ "request": {
+ "$ref": "LogExclusion"
+ },
+ "description": "Changes one or more properties of an existing exclusion.",
+ "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": "^billingAccounts/[^/]+/exclusions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ]
+ },
+ "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"
+ },
+ "response": {
+ "$ref": "LogExclusion"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "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": "^billingAccounts/[^/]+$"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions",
+ "path": "v2/{+parent}/exclusions",
+ "id": "logging.billingAccounts.exclusions.create"
+ }
+ }
+ },
+ "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",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/logs/{logsId}",
+ "id": "logging.billingAccounts.logs.delete",
+ "path": "v2/{+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",
+ "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": {
- "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.",
@@ -1398,50 +826,23 @@
"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"
- ],
- "flatPath": "v2/billingAccounts/{billingAccountsId}/logs",
- "id": "logging.billingAccounts.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": {
- "flatPath": "v2/billingAccounts/{billingAccountsId}/logs/{logsId}",
- "path": "v2/{+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": {
- "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,
+ },
+ "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",
- "pattern": "^billingAccounts/[^/]+/logs/[^/]+$"
+ "location": "query"
}
- }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/logs",
+ "path": "v2/{+parent}/logs",
+ "id": "logging.billingAccounts.logs.list"
}
}
},
"sinks": {
"methods": {
"get": {
+ "description": "Gets a sink.",
"httpMethod": "GET",
"parameterOrder": [
"sinkName"
@@ -1449,31 +850,30 @@
"response": {
"$ref": "LogSink"
},
- "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": "^billingAccounts/[^/]+/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": "^billingAccounts/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
"flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
"id": "logging.billingAccounts.sinks.get",
- "path": "v2/{+sinkName}",
- "description": "Gets a sink."
+ "path": "v2/{+sinkName}"
},
"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"
},
+ "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"
},
@@ -1481,49 +881,56 @@
"sinkName"
],
"httpMethod": "PATCH",
+ "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": {
+ "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"
],
- "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": "^billingAccounts/[^/]+/sinks/[^/]+$"
- },
- "uniqueWriterIdentity": {
- "type": "boolean",
- "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."
- },
- "updateMask": {
- "type": "string",
- "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"
- }
- },
"flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
"path": "v2/{+sinkName}",
"id": "logging.billingAccounts.sinks.patch"
},
"update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "sinkName"
- ],
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.billingAccounts.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": {
+ "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",
- "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\"."
+ "location": "path"
},
"uniqueWriterIdentity": {
"location": "query",
@@ -1531,25 +938,19 @@
"type": "boolean"
},
"updateMask": {
- "type": "string",
"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"
+ "format": "google-fieldmask",
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
- "id": "logging.billingAccounts.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."
+ ]
},
"delete": {
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
"response": {
"$ref": "Empty"
},
@@ -1563,19 +964,22 @@
],
"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": "^billingAccounts/[^/]+/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\"."
+ "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."
+ "id": "logging.billingAccounts.sinks.delete"
},
"list": {
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.billingAccounts.sinks.list",
+ "description": "Lists sinks.",
"response": {
"$ref": "ListSinksResponse"
},
@@ -1583,38 +987,41 @@
"parent"
],
"httpMethod": "GET",
- "parameters": {
- "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/[^/]+$"
- },
- "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": "v2/billingAccounts/{billingAccountsId}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.billingAccounts.sinks.list",
- "description": "Lists sinks."
+ "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 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/[^/]+$",
+ "location": "path"
+ }
+ }
},
"create": {
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.billingAccounts.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"
},
@@ -1635,50 +1042,51 @@
"pattern": "^billingAccounts/[^/]+$"
},
"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"
+ "type": "boolean",
+ "location": "query"
}
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.billingAccounts.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"
}
}
}
- },
+ }
+ }
+ },
+ "folders": {
+ "resources": {
"exclusions": {
"methods": {
"delete": {
- "response": {
- "$ref": "Empty"
- },
+ "description": "Deletes an exclusion.",
+ "httpMethod": "DELETE",
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
+ "response": {
+ "$ref": "Empty"
+ },
"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": "^billingAccounts/[^/]+/exclusions/[^/]+$"
+ "pattern": "^folders/[^/]+/exclusions/[^/]+$"
}
},
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.billingAccounts.exclusions.delete",
- "description": "Deletes an exclusion."
+ "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}"
},
"list": {
+ "flatPath": "v2/folders/{foldersId}/exclusions",
+ "path": "v2/{+parent}/exclusions",
+ "id": "logging.folders.exclusions.list",
+ "description": "Lists all the exclusions in a parent resource.",
"response": {
"$ref": "ListExclusionsResponse"
},
@@ -1686,41 +1094,37 @@
"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": "^billingAccounts/[^/]+$"
- },
- "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"
+ },
+ "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": "^folders/[^/]+$"
+ },
+ "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"
}
},
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.billingAccounts.exclusions.list",
- "description": "Lists all the exclusions in a parent resource."
+ "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"
+ ]
},
"get": {
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
+ "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
"path": "v2/{+name}",
- "id": "logging.billingAccounts.exclusions.get",
+ "id": "logging.folders.exclusions.get",
"description": "Gets the description of an exclusion.",
"response": {
"$ref": "LogExclusion"
@@ -1729,23 +1133,27 @@
"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": "^folders/[^/]+/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"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+/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\"."
- }
- }
+ ]
},
"patch": {
+ "description": "Changes one or more properties of an existing exclusion.",
+ "request": {
+ "$ref": "LogExclusion"
+ },
"response": {
"$ref": "LogExclusion"
},
@@ -1758,36 +1166,32 @@
"https://www.googleapis.com/auth/logging.admin"
],
"parameters": {
- "name": {
- "required": true,
- "type": "string",
- "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\"."
- },
"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"
+ "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": "^folders/[^/]+/exclusions/[^/]+$"
}
},
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}",
+ "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
"path": "v2/{+name}",
- "id": "logging.billingAccounts.exclusions.patch",
- "description": "Changes one or more properties of an existing exclusion.",
- "request": {
- "$ref": "LogExclusion"
- }
+ "id": "logging.folders.exclusions.patch"
},
"create": {
- "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions",
- "id": "logging.billingAccounts.exclusions.create",
+ "flatPath": "v2/folders/{foldersId}/exclusions",
+ "id": "logging.folders.exclusions.create",
"path": "v2/{+parent}/exclusions",
+ "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"
},
- "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"
@@ -1795,29 +1199,54 @@
"response": {
"$ref": "LogExclusion"
},
- "parameters": {
- "parent": {
- "required": true,
- "type": "string",
- "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\"."
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
- ]
+ ],
+ "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": "^folders/[^/]+$",
+ "location": "path"
+ }
+ }
}
}
- }
- }
- },
- "folders": {
- "resources": {
+ },
"logs": {
"methods": {
+ "delete": {
+ "flatPath": "v2/folders/{foldersId}/logs/{logsId}",
+ "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": {
+ "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"
+ }
+ }
+ },
"list": {
+ "flatPath": "v2/folders/{foldersId}/logs",
+ "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"
@@ -1839,54 +1268,160 @@
"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"
+ "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": "^folders/[^/]+$"
+ "pattern": "^folders/[^/]+$",
+ "location": "path"
}
- },
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "logName": {
- "required": true,
- "type": "string",
- "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."
- }
- },
- "flatPath": "v2/folders/{foldersId}/logs/{logsId}",
- "path": "v2/{+logName}",
- "id": "logging.folders.logs.delete"
+ }
}
}
},
"sinks": {
"methods": {
+ "get": {
+ "description": "Gets a sink.",
+ "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"
+ },
+ "patch": {
+ "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.folders.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.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PATCH",
+ "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": {
+ "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"
+ ]
+ },
+ "update": {
+ "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": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "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": {
+ "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"
+ }
+ },
+ "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.",
+ "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"
+ },
"list": {
+ "description": "Lists sinks.",
"response": {
"$ref": "ListSinksResponse"
},
@@ -1902,9 +1437,9 @@
],
"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",
- "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."
+ "location": "query"
},
"pageSize": {
"location": "query",
@@ -1913,330 +1448,29 @@
"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": "^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"
+ "location": "path"
}
},
"flatPath": "v2/folders/{foldersId}/sinks",
"path": "v2/{+parent}/sinks",
- "id": "logging.folders.sinks.list",
- "description": "Lists sinks."
+ "id": "logging.folders.sinks.list"
},
"create": {
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "required": true,
- "type": "string",
- "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\"."
- },
- "uniqueWriterIdentity": {
- "type": "boolean",
- "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."
- }
- },
- "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",
+ "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"
},
- "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",
- "parameters": {
- "sinkName": {
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+/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\"."
- }
- },
- "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": {
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "sinkName": {
- "required": true,
- "type": "string",
- "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\"."
- },
- "uniqueWriterIdentity": {
- "type": "boolean",
- "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."
- },
- "updateMask": {
- "type": "string",
- "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"
- }
- },
- "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",
- "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": {
- "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": {
- "required": true,
- "type": "string",
- "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\"."
- },
- "uniqueWriterIdentity": {
- "type": "boolean",
- "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."
- },
- "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}",
- "id": "logging.folders.sinks.update",
- "path": "v2/{+sinkName}"
- },
- "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": "^folders/[^/]+/sinks/[^/]+$"
- }
- },
- "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."
- }
- }
- },
- "exclusions": {
- "methods": {
- "delete": {
- "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.folders.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": {
- "required": true,
- "type": "string",
- "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\"."
- }
- }
- },
- "list": {
- "response": {
- "$ref": "ListExclusionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "parent": {
- "required": true,
- "type": "string",
- "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"
- }
- },
- "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",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.folders.exclusions.list",
- "description": "Lists all the exclusions in a parent resource."
- },
- "get": {
- "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": {
- "required": true,
- "type": "string",
- "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\"."
- }
- },
- "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.folders.exclusions.get",
- "description": "Gets the description of an exclusion."
- },
- "patch": {
- "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}",
- "path": "v2/{+name}",
- "id": "logging.folders.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": {
- "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": {
- "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": "^folders/[^/]+/exclusions/[^/]+$"
- }
- }
- },
- "create": {
- "flatPath": "v2/folders/{foldersId}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.folders.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"
- },
- "response": {
- "$ref": "LogExclusion"
- },
- "parameterOrder": [
"parent"
],
"httpMethod": "POST",
@@ -2245,12 +1479,17 @@
"https://www.googleapis.com/auth/logging.admin"
],
"parameters": {
+ "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"
+ },
"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": "^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\"."
+ "location": "path"
}
}
}
@@ -2261,6 +1500,7 @@
"exclusions": {
"methods": {
"delete": {
+ "description": "Deletes an exclusion.",
"response": {
"$ref": "Empty"
},
@@ -2268,10 +1508,6 @@
"name"
],
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
"parameters": {
"name": {
"location": "path",
@@ -2281,15 +1517,15 @@
"pattern": "^[^/]+/[^/]+/exclusions/[^/]+$"
}
},
+ "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.delete",
- "description": "Deletes an exclusion."
+ "id": "logging.exclusions.delete"
},
"list": {
- "flatPath": "v2/{v2Id}/{v2Id1}/exclusions",
- "path": "v2/{+parent}/exclusions",
- "id": "logging.exclusions.list",
"description": "Lists all the exclusions in a parent resource.",
"response": {
"$ref": "ListExclusionsResponse"
@@ -2305,27 +1541,31 @@
"https://www.googleapis.com/auth/logging.read"
],
"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"
+ },
"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": "^[^/]+/[^/]+$",
- "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"
+ "pattern": "^[^/]+/[^/]+$"
},
"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"
+ "type": "string",
+ "location": "query"
}
- }
+ },
+ "flatPath": "v2/{v2Id}/{v2Id1}/exclusions",
+ "path": "v2/{+parent}/exclusions",
+ "id": "logging.exclusions.list"
},
"get": {
+ "description": "Gets the description of an exclusion.",
"httpMethod": "GET",
"parameterOrder": [
"name"
@@ -2333,40 +1573,39 @@
"response": {
"$ref": "LogExclusion"
},
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "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\"."
- }
- },
"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": {
+ "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": "^[^/]+/[^/]+/exclusions/[^/]+$"
+ }
+ },
"flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}",
"id": "logging.exclusions.get",
- "path": "v2/{+name}",
- "description": "Gets the description of an exclusion."
+ "path": "v2/{+name}"
},
"patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "LogExclusion"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
"parameters": {
"updateMask": {
- "type": "string",
- "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"
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
},
"name": {
"location": "path",
@@ -2381,28 +1620,32 @@
"https://www.googleapis.com/auth/logging.admin"
],
"flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}",
- "id": "logging.exclusions.patch",
"path": "v2/{+name}",
+ "id": "logging.exclusions.patch",
"request": {
"$ref": "LogExclusion"
},
"description": "Changes one or more properties of an existing exclusion."
},
"create": {
- "response": {
+ "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"
],
- "httpMethod": "POST",
+ "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": "^[^/]+/[^/]+$",
- "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\"."
+ "pattern": "^[^/]+/[^/]+$"
}
},
"scopes": [
@@ -2410,58 +1653,806 @@
"https://www.googleapis.com/auth/logging.admin"
],
"flatPath": "v2/{v2Id}/{v2Id1}/exclusions",
- "path": "v2/{+parent}/exclusions",
"id": "logging.exclusions.create",
- "request": {
- "$ref": "LogExclusion"
+ "path": "v2/{+parent}/exclusions"
+ }
+ }
+ },
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "list": {
+ "flatPath": "v2/monitoredResourceDescriptors",
+ "path": "v2/monitoredResourceDescriptors",
+ "id": "logging.monitoredResourceDescriptors.list",
+ "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging.",
+ "response": {
+ "$ref": "ListMonitoredResourceDescriptorsResponse"
},
- "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."
+ "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/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "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",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/organizations/{organizationsId}/logs/{logsId}",
+ "id": "logging.organizations.logs.delete",
+ "path": "v2/{+logName}"
+ },
+ "list": {
+ "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.",
+ "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": "^organizations/[^/]+$",
+ "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"
+ ]
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "patch": {
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.organizations.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": {
+ "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": "^organizations/[^/]+/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": {
+ "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"
+ }
+ }
+ },
+ "update": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "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": "^organizations/[^/]+/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"
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.organizations.sinks.update",
+ "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"
+ }
+ },
+ "delete": {
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
+ "id": "logging.organizations.sinks.delete",
+ "path": "v2/{+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"
+ ],
+ "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"
+ ]
+ },
+ "list": {
+ "description": "Lists sinks.",
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
+ "parameterOrder": [
+ "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": {
+ "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 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/[^/]+$"
+ }
+ },
+ "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",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.organizations.sinks.list"
+ },
+ "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": "^organizations/[^/]+$"
+ },
+ "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."
+ }
+ }
+ },
+ "exclusions": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an exclusion.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "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/[^/]+$"
+ }
+ },
+ "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.delete",
+ "path": "v2/{+name}"
+ },
+ "list": {
+ "flatPath": "v2/organizations/{organizationsId}/exclusions",
+ "path": "v2/{+parent}/exclusions",
+ "id": "logging.organizations.exclusions.list",
+ "description": "Lists all the exclusions in a parent resource.",
+ "response": {
+ "$ref": "ListExclusionsResponse"
+ },
+ "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": {
+ "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": "^organizations/[^/]+$",
+ "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"
+ ]
+ },
+ "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": {
+ "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/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}",
+ "path": "v2/{+name}",
+ "id": "logging.organizations.exclusions.get"
+ },
+ "patch": {
+ "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.",
+ "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": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ]
+ },
+ "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"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "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": "^organizations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/organizations/{organizationsId}/exclusions",
+ "path": "v2/{+parent}/exclusions",
+ "id": "logging.organizations.exclusions.create"
+ }
+ }
+ }
+ }
+ },
+ "entries": {
+ "methods": {
+ "list": {
+ "flatPath": "v2/entries:list",
+ "path": "v2/entries:list",
+ "id": "logging.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.",
+ "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"
+ ]
+ },
+ "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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "WriteLogEntriesResponse"
+ },
+ "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",
+ "id": "logging.entries.write",
+ "path": "v2/entries:write"
+ }
+ }
+ },
+ "logs": {
+ "methods": {
+ "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": {
+ "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 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": "^[^/]+/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/{v2Id}/{v2Id1}/logs",
+ "path": "v2/{+parent}/logs",
+ "id": "logging.logs.list",
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
+ },
+ "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": "^[^/]+/[^/]+/logs/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/{v2Id}/{v2Id1}/logs/{logsId}",
+ "path": "v2/{+logName}",
+ "id": "logging.logs.delete"
+ }
+ }
+ },
+ "sinks": {
+ "methods": {
+ "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": {
+ "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 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": "^[^/]+/[^/]+$"
+ }
+ },
+ "flatPath": "v2/{v2Id}/{v2Id1}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.sinks.list"
+ },
+ "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": "^[^/]+/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.sinks.get",
+ "description": "Gets a sink."
+ },
+ "update": {
+ "httpMethod": "PUT",
+ "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": "^[^/]+/[^/]+/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/{v2Id}/{v2Id1}/sinks/{sinksId}",
+ "id": "logging.sinks.update",
+ "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"
+ }
+ },
+ "create": {
+ "flatPath": "v2/{v2Id}/{v2Id1}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.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": {
+ "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": "^[^/]+/[^/]+$",
+ "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"
+ ]
+ },
+ "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": "^[^/]+/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}",
+ "id": "logging.sinks.delete",
+ "path": "v2/{+sinkName}"
}
}
}
},
"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": {
+ "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"
},
"$.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": {
- "location": "query",
"description": "JSONP",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"alt": {
- "default": "json",
"enum": [
"json",
"media",
@@ -2474,22 +2465,23 @@
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response."
- },
- "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": "Data format for response.",
+ "default": "json"
},
"access_token": {
"location": "query",
"description": "OAuth access token.",
"type": "string"
},
- "quotaUser": {
- "type": "string",
+ "key": {
"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"
+ },
+ "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",
@@ -2498,14 +2490,25 @@
"default": "true"
},
"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"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
"location": "query",
- "description": "OAuth bearer token."
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
}
},
"version": "v2",
@@ -2520,466 +2523,20 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "WriteLogEntriesRequest": {
- "type": "object",
- "properties": {
- "logName": {
- "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 might be discarded. Discarding does not return an error.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.",
- "type": "array",
- "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"
- },
- "labels": {
- "type": "object",
- "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."
- },
- "resource": {
- "$ref": "MonitoredResource",
- "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."
- }
- },
- "id": "WriteLogEntriesRequest",
- "description": "The parameters to WriteLogEntries."
- },
- "LabelDescriptor": {
- "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",
- "description": "A description of a label."
- },
- "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": {
- "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"
- },
- "MetricDescriptor": {
- "type": "object",
- "properties": {
- "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": {
- "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": {
- "type": "string",
- "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"
- },
- "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": {
- "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."
- },
- "displayName": {
- "type": "string",
- "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."
- },
- "description": {
- "description": "A detailed description of the metric, which can be used in documentation.",
- "type": "string"
- }
- },
- "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."
- },
- "LogEntry": {
- "description": "An individual entry in a log.",
- "type": "object",
- "properties": {
- "textPayload": {
- "type": "string",
- "description": "The log entry payload, represented as a Unicode string (UTF-8)."
- },
- "protoPayload": {
- "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."
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
- "type": "object"
- },
- "trace": {
- "type": "string",
- "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"
- },
- "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 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",
- "INFO",
- "NOTICE",
- "WARNING",
- "ERROR",
- "CRITICAL",
- "ALERT",
- "EMERGENCY"
- ],
- "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT."
- },
- "sourceLocation": {
- "$ref": "LogEntrySourceLocation",
- "description": "Optional. Source code location information associated with the log entry, if any."
- },
- "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": {
- "type": "string",
- "description": "Output only. The time the log entry was received by Stackdriver Logging.",
- "format": "google-datetime"
- },
- "timestamp": {
- "type": "string",
- "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. See the entries.write API method for more information.",
- "format": "google-datetime"
- },
- "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": {
- "$ref": "HttpRequest",
- "description": "Optional. Information about the HTTP request associated with this log entry, if applicable."
- },
- "resource": {
- "$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": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- },
- "description": "The log entry payload, represented as a structure that is expressed as a JSON 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"
- }
- },
- "id": "LogEntry"
- },
- "RequestLog": {
- "type": "object",
- "properties": {
- "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": {
- "type": "string",
- "description": "Time when the request finished.",
- "format": "google-datetime"
- },
- "userAgent": {
- "description": "User agent that made the request.",
- "type": "string"
- },
- "wasLoadingRequest": {
- "type": "boolean",
- "description": "Whether this was a loading request for the instance."
- },
- "sourceReference": {
- "type": "array",
- "items": {
- "$ref": "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."
- },
- "responseSize": {
- "type": "string",
- "description": "Size in bytes sent back to client by request.",
- "format": "int64"
- },
- "traceId": {
- "type": "string",
- "description": "Stackdriver Trace identifier for this request."
- },
- "line": {
- "type": "array",
- "items": {
- "$ref": "LogLine"
- },
- "description": "A list of log lines emitted by the application while serving this request."
- },
- "taskQueueName": {
- "type": "string",
- "description": "Queue name of the request, in the case of an offline request."
- },
- "referrer": {
- "type": "string",
- "description": "Referrer URL of request."
- },
- "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"
- },
- "pendingTime": {
- "description": "Time this request spent in the pending request queue.",
- "format": "google-duration",
- "type": "string"
- },
- "resource": {
- "type": "string",
- "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."
- },
- "status": {
- "description": "HTTP response status code. Example: 200, 404.",
- "format": "int32",
- "type": "integer"
- },
- "taskName": {
- "type": "string",
- "description": "Task name of the request, in the case of an offline request."
- },
- "urlMapEntry": {
- "type": "string",
- "description": "File or class that handled the request."
- },
- "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": {
- "type": "string",
- "description": "Latency of the request.",
- "format": "google-duration"
- },
- "ip": {
- "description": "Origin IP address.",
- "type": "string"
- },
- "appId": {
- "description": "Application that handled this request.",
- "type": "string"
- },
- "appEngineRelease": {
- "type": "string",
- "description": "App Engine release version."
- },
- "method": {
- "type": "string",
- "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\"."
- },
- "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"
- }
- },
- "id": "RequestLog",
- "description": "Complete log information about a single HTTP request to an App Engine application."
- },
- "LogExclusion": {
- "type": "object",
- "properties": {
- "filter": {
- "description": "Required. An advanced logs filter that matches the log entries to be excluded. By using the sample function, you can exclude less than 100% of the matching log entries. For example, the following filter matches 99% of low-severity log entries from load balancers:\n\"resource.type=http_load_balancer severity\u003cERROR sample(insertId, 0.99)\"\n",
- "type": "string"
- },
- "disabled": {
- "type": "boolean",
- "description": "Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can use exclusions.patch to change the value of this field."
- },
- "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.",
- "type": "string"
- },
- "description": {
- "type": "string",
- "description": "Optional. A description of this exclusion."
- }
- },
- "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."
- },
"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"
- },
- "description": "A list of resource descriptors."
- },
- "nextPageToken": {
- "type": "string",
- "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."
+ }
}
},
"id": "ListMonitoredResourceDescriptorsResponse"
@@ -2996,24 +2553,39 @@
}
},
"nextPageToken": {
- "type": "string",
- "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."
+ "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": "ListExclusionsResponse"
},
+ "LogEntryOperation": {
+ "description": "Additional information about a potentially long-running operation with which a log entry is associated.",
+ "type": "object",
+ "properties": {
+ "producer": {
+ "description": "Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: \"MyDivision.MyBigCompany.com\", \"github.com/MyProject/MyApplication\".",
+ "type": "string"
+ },
+ "first": {
+ "description": "Optional. Set this to True if this is the first log entry in the operation.",
+ "type": "boolean"
+ },
+ "last": {
+ "description": "Optional. Set this to True if this is the last log entry in the operation.",
+ "type": "boolean"
+ },
+ "id": {
+ "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
+ "type": "string"
+ }
+ },
+ "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": {
- "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."
- },
- "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"
- },
"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"
@@ -3025,22 +2597,22 @@
"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": {
- "$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."
- },
"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."
+ ],
+ "enum": [
+ "V2",
+ "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"
@@ -3048,33 +2620,18 @@
"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.",
- "type": "object",
- "properties": {
- "producer": {
- "description": "Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: \"MyDivision.MyBigCompany.com\", \"github.com/MyProject/MyApplication\".",
- "type": "string"
- },
- "first": {
- "type": "boolean",
- "description": "Optional. Set this to True if this is the first log entry in the operation."
- },
- "last": {
- "type": "boolean",
- "description": "Optional. Set this to True if this is the last log entry in the operation."
- },
- "id": {
- "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
- "type": "string"
- }
- },
- "id": "LogEntryOperation"
- },
"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",
@@ -3084,33 +2641,43 @@
"type": "string"
},
"labels": {
- "type": "object",
"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\"."
+ "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"
}
},
"id": "MonitoredResource"
},
"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": {
+ "filter": {
+ "description": "Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example:\nlogName=\"projects/[PROJECT_ID]/logs/[LOG_ID]\" AND severity\u003e=ERROR\n",
+ "type": "string"
+ },
+ "destination": {
+ "description": "Required. The export destination:\n\"storage.googleapis.com/[GCS_BUCKET]\"\n\"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"\n\"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]\"\nThe sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks.",
+ "type": "string"
+ },
"endTime": {
- "type": "string",
"description": "Deprecated. This field is ignored when creating or updating sinks.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "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": {
- "type": "string",
- "description": "Deprecated. This field is ignored when creating or updating sinks.",
- "format": "google-datetime"
- },
"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.",
@@ -3121,28 +2688,18 @@
"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."
+ ]
},
"name": {
- "type": "string",
- "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."
+ "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"
},
"includeChildren": {
"description": "Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:\nlogName:(\"projects/test-project1/\" OR \"projects/test-project2/\") AND\nresource.type=gce_instance\n",
"type": "boolean"
- },
- "destination": {
- "type": "string",
- "description": "Required. The export destination:\n\"storage.googleapis.com/[GCS_BUCKET]\"\n\"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"\n\"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]\"\nThe sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks."
- },
- "filter": {
- "type": "string",
- "description": "Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. For example:\nlogName=\"projects/[PROJECT_ID]/logs/[LOG_ID]\" AND severity\u003e=ERROR\n"
}
},
- "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."
+ "id": "LogSink"
},
"ListLogsResponse": {
"description": "Result returned from ListLogs.",
@@ -3156,42 +2713,82 @@
}
},
"nextPageToken": {
- "type": "string",
- "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."
+ "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": "ListLogsResponse"
},
+ "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": {
- "requestSize": {
- "type": "string",
- "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
- "format": "int64"
+ "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": {
- "type": "string",
- "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\""
+ "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"
+ },
"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": {
- "type": "string",
- "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\"."
- },
"cacheLookup": {
"description": "Whether or not a cache lookup was attempted.",
"type": "boolean"
@@ -3201,65 +2798,21 @@
"type": "boolean"
},
"cacheValidatedWithOriginServer": {
- "type": "boolean",
- "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."
+ "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": {
- "type": "integer",
"description": "The response code indicating the status of response. Examples: 200, 404.",
- "format": "int32"
- },
- "referer": {
- "type": "string",
- "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)."
- },
- "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": {
- "type": "string",
- "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
- "format": "int64"
- },
- "requestMethod": {
- "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
- "type": "string"
+ "format": "int32",
+ "type": "integer"
}
},
"id": "HttpRequest"
},
- "ListSinksResponse": {
- "type": "object",
- "properties": {
- "sinks": {
- "type": "array",
- "items": {
- "$ref": "LogSink"
- },
- "description": "A list of sinks."
- },
- "nextPageToken": {
- "type": "string",
- "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."
- }
- },
- "id": "ListSinksResponse",
- "description": "Result returned from ListSinks."
- },
"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": {
- "name": {
- "type": "string",
- "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}\"."
- },
"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"
@@ -3269,38 +2822,42 @@
"type": "string"
},
"type": {
- "type": "string",
- "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."
+ "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"
- },
- "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\"."
+ }
+ },
+ "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"
},
"LogEntrySourceLocation": {
+ "description": "Additional information about the source code location that produced the log entry.",
"type": "object",
"properties": {
"file": {
- "type": "string",
- "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name."
+ "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
+ "type": "string"
},
"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": {
- "type": "string",
"description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
}
},
- "id": "LogEntrySourceLocation",
- "description": "Additional information about the source code location that produced the log entry."
+ "id": "LogEntrySourceLocation"
},
"ListLogEntriesResponse": {
"description": "Result returned from ListLogEntries.",
@@ -3311,11 +2868,11 @@
"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"
- },
- "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."
+ }
}
},
"id": "ListLogEntriesResponse"
@@ -3325,6 +2882,17 @@
"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",
@@ -3337,70 +2905,59 @@
"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": {
- "type": "string",
- "description": "App-provided log message."
+ "description": "App-provided log message.",
+ "type": "string"
},
"sourceLocation": {
- "$ref": "SourceLocation",
- "description": "Where in the source code this log message was written."
+ "description": "Where in the source code this log message was written.",
+ "$ref": "SourceLocation"
},
"time": {
- "type": "string",
"description": "Approximate time when this log entry was made.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
}
},
"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": {
- "offset": {
- "type": "number",
- "description": "Lower bound of the first bucket.",
- "format": "double"
- },
"numFiniteBuckets": {
- "type": "integer",
"description": "Must be greater than 0.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"width": {
- "type": "number",
"description": "Must be greater than 0.",
- "format": "double"
+ "format": "double",
+ "type": "number"
+ },
+ "offset": {
+ "description": "Lower bound of the first bucket.",
+ "format": "double",
+ "type": "number"
}
},
- "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))."
+ "id": "Linear"
},
"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",
- "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 {}."
+ "id": "Empty"
},
"SourceLocation": {
"description": "Specifies a location in a source code file.",
"type": "object",
"properties": {
"file": {
- "type": "string",
- "description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name."
+ "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).",
@@ -3415,16 +2972,13 @@
"id": "SourceLocation"
},
"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": {
- "type": "integer",
"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"
+ "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.",
@@ -3447,12 +3001,16 @@
"items": {
"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"
}
},
- "id": "ListLogEntriesRequest",
- "description": "The parameters to ListLogEntries."
+ "id": "ListLogEntriesRequest"
},
"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": {
@@ -3464,42 +3022,42 @@
}
}
},
- "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."
+ "id": "Explicit"
},
"SourceReference": {
+ "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.",
"type": "object",
"properties": {
- "repository": {
- "type": "string",
- "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\""
- },
"revisionId": {
"description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
"type": "string"
+ },
+ "repository": {
+ "description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
+ "type": "string"
}
},
- "id": "SourceReference",
- "description": "A reference to a particular snapshot of the source tree used to build and deploy an application."
+ "id": "SourceReference"
},
"WriteLogEntriesResponse": {
+ "description": "Result returned from WriteLogEntries. empty",
"type": "object",
"properties": {},
- "id": "WriteLogEntriesResponse",
- "description": "Result returned from WriteLogEntries. empty"
+ "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": {
- "type": "number",
"description": "Must be greater than 0.",
- "format": "double"
+ "format": "double",
+ "type": "number"
},
"numFiniteBuckets": {
"description": "Must be greater than 0.",
@@ -3507,14 +3065,459 @@
"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))."
+ "id": "Exponential"
+ },
+ "WriteLogEntriesRequest": {
+ "description": "The parameters to WriteLogEntries.",
+ "type": "object",
+ "properties": {
+ "logName": {
+ "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 might be discarded. Discarding does not return an error.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.",
+ "type": "array",
+ "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"
+ },
+ "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"
+ },
+ "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": {
+ "linearBuckets": {
+ "$ref": "Linear",
+ "description": "The linear bucket."
+ },
+ "explicitBuckets": {
+ "description": "The explicit buckets.",
+ "$ref": "Explicit"
+ },
+ "exponentialBuckets": {
+ "description": "The exponential buckets.",
+ "$ref": "Exponential"
+ }
+ },
+ "id": "BucketOptions"
+ },
+ "ListLogMetricsResponse": {
+ "description": "Result returned from ListLogMetrics.",
+ "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"
+ },
+ "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": {
+ "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": {
+ "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.",
+ "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"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "id": "MetricDescriptor"
+ },
+ "LogEntry": {
+ "description": "An individual entry in a log.",
+ "type": "object",
+ "properties": {
+ "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. 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"
+ }
+ },
+ "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.",
+ "(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",
+ "INFO",
+ "NOTICE",
+ "WARNING",
+ "ERROR",
+ "CRITICAL",
+ "ALERT",
+ "EMERGENCY"
+ ]
+ },
+ "sourceLocation": {
+ "description": "Optional. Source code location information associated with the log entry, if any.",
+ "$ref": "LogEntrySourceLocation"
+ },
+ "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. See the entries.write API method for more information.",
+ "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": {
+ "$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."
+ },
+ "httpRequest": {
+ "$ref": "HttpRequest",
+ "description": "Optional. Information about the HTTP request associated with this log entry, if applicable."
+ },
+ "jsonPayload": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
+ "type": "object"
+ },
+ "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"
+ }
+ },
+ "id": "LogEntry"
+ },
+ "RequestLog": {
+ "description": "Complete log information about a single HTTP request to an App Engine application.",
+ "type": "object",
+ "properties": {
+ "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.",
+ "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",
+ "type": "integer"
+ },
+ "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": {
+ "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": {
+ "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": {
+ "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",
+ "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"
+ }
+ }
+ },
+ "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": {
+ "description": {
+ "description": "Optional. A description of this exclusion.",
+ "type": "string"
+ },
+ "filter": {
+ "description": "Required. An advanced logs filter that matches the log entries to be excluded. By using the sample function, you can exclude less than 100% of the matching log entries. For example, the following filter matches 99% of low-severity log entries from load balancers:\n\"resource.type=http_load_balancer severity\u003cERROR sample(insertId, 0.99)\"\n",
+ "type": "string"
+ },
+ "disabled": {
+ "description": "Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can use exclusions.patch to change the value of this field.",
+ "type": "boolean"
+ },
+ "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.",
+ "type": "string"
+ }
+ },
+ "id": "LogExclusion"
}
},
"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": {
@@ -3540,8 +3543,5 @@
},
"rootUrl": "https://logging.googleapis.com/",
"ownerDomain": "google.com",
- "name": "logging",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Stackdriver Logging API"
+ "name": "logging"
}
diff --git a/logging/v2beta1/logging-api.json b/logging/v2beta1/logging-api.json
index 8f91a8a..00ed2ab 100644
--- a/logging/v2beta1/logging-api.json
+++ b/logging/v2beta1/logging-api.json
@@ -1,24 +1,35 @@
{
"basePath": "",
- "revision": "20171211",
- "documentationLink": "https://cloud.google.com/logging/docs/",
"id": "logging:v2beta1",
+ "documentationLink": "https://cloud.google.com/logging/docs/",
+ "revision": "20171211",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "Exponential": {
+ "properties": {
+ "growthFactor": {
+ "description": "Must be greater than 1.",
+ "format": "double",
+ "type": "number"
+ },
+ "scale": {
+ "description": "Must be greater than 0.",
+ "format": "double",
+ "type": "number"
+ },
+ "numFiniteBuckets": {
+ "description": "Must be greater than 0.",
+ "format": "int32",
+ "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"
+ },
"WriteLogEntriesRequest": {
"properties": {
- "logName": {
- "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 might be discarded. Discarding does not return an error.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.",
- "type": "array",
- "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"
@@ -31,8 +42,19 @@
"type": "object"
},
"resource": {
- "$ref": "MonitoredResource",
- "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."
+ "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": {
+ "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 might be discarded. Discarding does not return an error.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.",
+ "type": "array",
+ "items": {
+ "$ref": "LogEntry"
+ }
}
},
"id": "WriteLogEntriesRequest",
@@ -40,8 +62,13 @@
"type": "object"
},
"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"
@@ -59,22 +86,17 @@
"Boolean; true or false.",
"A 64-bit signed integer."
]
- },
- "key": {
- "description": "The label key.",
- "type": "string"
}
},
- "id": "LabelDescriptor",
- "description": "A description of a label."
+ "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"
+ "$ref": "Exponential",
+ "description": "The exponential buckets."
},
"linearBuckets": {
"description": "The linear bucket.",
@@ -91,54 +113,23 @@
"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"
+ },
+ "metrics": {
+ "description": "A list of logs-based metrics.",
+ "type": "array",
+ "items": {
+ "$ref": "LogMetric"
+ }
}
},
"id": "ListLogMetricsResponse"
},
"MetricDescriptor": {
- "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",
"properties": {
- "valueType": {
- "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."
- ],
- "enum": [
- "VALUE_TYPE_UNSPECIFIED",
- "BOOL",
- "INT64",
- "DOUBLE",
- "STRING",
- "DISTRIBUTION",
- "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": [
@@ -146,11 +137,17 @@
"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": {
- "type": "string",
- "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."
+ "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.",
@@ -174,11 +171,79 @@
"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."
+ ]
}
- }
+ },
+ "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"
},
"LogEntry": {
+ "description": "An individual entry in a log.",
+ "type": "object",
"properties": {
+ "labels": {
+ "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": {
+ "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",
+ "INFO",
+ "NOTICE",
+ "WARNING",
+ "ERROR",
+ "CRITICAL",
+ "ALERT",
+ "EMERGENCY"
+ ],
+ "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.",
+ "type": "string"
+ },
+ "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"
@@ -202,8 +267,8 @@
"$ref": "HttpRequest"
},
"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": {
@@ -218,174 +283,26 @@
"type": "string"
},
"operation": {
- "$ref": "LogEntryOperation",
- "description": "Optional. Information about an operation associated with the log entry, if applicable."
+ "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"
},
"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"
- }
- },
- "labels": {
- "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "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.",
- "(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",
- "INFO",
- "NOTICE",
- "WARNING",
- "ERROR",
- "CRITICAL",
- "ALERT",
- "EMERGENCY"
- ]
- },
- "sourceLocation": {
- "$ref": "LogEntrySourceLocation",
- "description": "Optional. Source code location information associated with the log entry, if 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"
}
},
- "id": "LogEntry",
- "description": "An individual entry in a log.",
- "type": "object"
+ "id": "LogEntry"
},
"RequestLog": {
- "id": "RequestLog",
- "description": "Complete log information about a single HTTP request to an App Engine application.",
- "type": "object",
"properties": {
- "line": {
- "description": "A list of log lines emitted by the application while serving this request.",
- "type": "array",
- "items": {
- "$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.",
- "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"
- },
- "status": {
- "description": "HTTP response status code. Example: 200, 404.",
- "format": "int32",
- "type": "integer"
- },
- "resource": {
- "type": "string",
- "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."
- },
- "pendingTime": {
- "description": "Time this request spent in the pending request queue.",
- "format": "google-duration",
- "type": "string"
- },
- "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",
- "type": "integer"
- },
- "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": {
- "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": {
- "type": "string",
- "description": "Origin IP address."
- },
- "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"
@@ -426,29 +343,133 @@
"traceId": {
"description": "Stackdriver Trace identifier for this request.",
"type": "string"
- }
- }
- },
- "ListMonitoredResourceDescriptorsResponse": {
- "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.",
+ },
+ "line": {
+ "description": "A list of log lines emitted by the application while serving this request.",
+ "type": "array",
+ "items": {
+ "$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.",
+ "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",
+ "type": "integer"
+ },
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "id": "RequestLog",
+ "description": "Complete log information about a single HTTP request to an App Engine application.",
+ "type": "object"
+ },
+ "ListMonitoredResourceDescriptorsResponse": {
+ "description": "Result returned from ListMonitoredResourceDescriptors.",
+ "type": "object",
+ "properties": {
"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",
- "description": "Result returned from ListMonitoredResourceDescriptors."
+ "id": "ListMonitoredResourceDescriptorsResponse"
},
"LogEntryOperation": {
- "id": "LogEntryOperation",
"description": "Additional information about a potentially long-running operation with which a log entry is associated.",
"type": "object",
"properties": {
@@ -468,20 +489,33 @@
"description": "Optional. Set this to True if this is the first log entry in the operation.",
"type": "boolean"
}
- }
+ },
+ "id": "LogEntryOperation"
},
"LogMetric": {
"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"
},
"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"
- }
+ },
+ "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": {
"enum": [
@@ -496,24 +530,12 @@
]
},
"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"
+ "$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": {
- "type": "string",
- "description": "Optional. A description of this metric, which is used in documentation."
- },
- "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",
@@ -539,8 +561,6 @@
"id": "MonitoredResource"
},
"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": {
"includeChildren": {
"description": "Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then logs from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression. For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name:\nlogName:(\"projects/test-project1/\" OR \"projects/test-project2/\") AND\nresource.type=gce_instance\n",
@@ -564,122 +584,54 @@
"type": "string"
},
"startTime": {
- "type": "string",
"description": "Deprecated. This field is ignored when creating or updating sinks.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"outputVersionFormat": {
+ "enumDescriptions": [
+ "An unspecified format version that will default to V2.",
+ "LogEntry version 2 format.",
+ "LogEntry version 1 format."
+ ],
"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."
- ]
+ "type": "string"
},
"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"
}
},
- "id": "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"
},
"ListLogsResponse": {
"description": "Result returned from ListLogs.",
"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"
+ },
"logNames": {
"description": "A list of log names. For example, \"projects/my-project/syslog\" or \"organizations/123/cloudresourcemanager.googleapis.com%2Factivity\".",
"type": "array",
"items": {
"type": "string"
}
- },
- "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": "ListLogsResponse"
},
- "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": {
- "type": "string",
- "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)."
- },
- "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": {
- "type": "string",
- "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\"."
- },
- "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"
- },
- "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"
- },
- "cacheLookup": {
- "description": "Whether or not a cache lookup was attempted.",
- "type": "boolean"
- },
- "cacheHit": {
- "description": "Whether or not an entity was served from cache (with or without validation).",
- "type": "boolean"
- }
- },
- "id": "HttpRequest"
- },
"ListSinksResponse": {
+ "description": "Result returned from ListSinks.",
+ "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 the same method again using the value of nextPageToken as pageToken.",
@@ -693,14 +645,95 @@
}
}
},
- "id": "ListSinksResponse",
- "description": "Result returned from ListSinks.",
- "type": "object"
+ "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": {
+ "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"
+ },
+ "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"
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ },
+ "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"
+ }
+ },
+ "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\".",
+ "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"
@@ -712,28 +745,12 @@
"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"
},
"LogEntrySourceLocation": {
"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"
@@ -741,6 +758,11 @@
"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",
@@ -752,15 +774,15 @@
"type": "object",
"properties": {
"nextPageToken": {
- "type": "string",
- "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."
+ "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"
- },
- "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."
+ }
}
},
"id": "ListLogEntriesResponse"
@@ -769,6 +791,11 @@
"description": "Application log line emitted while processing a request.",
"type": "object",
"properties": {
+ "time": {
+ "description": "Approximate time when this log entry was made.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"severity": {
"enum": [
"DEFAULT",
@@ -802,23 +829,14 @@
"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"
}
},
"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": {
- "numFiniteBuckets": {
- "description": "Must be greater than 0.",
- "format": "int32",
- "type": "integer"
- },
"width": {
"description": "Must be greater than 0.",
"format": "double",
@@ -828,10 +846,14 @@
"description": "Lower bound of the first bucket.",
"format": "double",
"type": "number"
+ },
+ "numFiniteBuckets": {
+ "description": "Must be greater than 0.",
+ "format": "int32",
+ "type": "integer"
}
},
- "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))."
+ "id": "Linear"
},
"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 {}.",
@@ -840,37 +862,39 @@
"id": "Empty"
},
"SourceLocation": {
+ "description": "Specifies a location in a source code file.",
"type": "object",
"properties": {
"file": {
- "type": "string",
- "description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name."
+ "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"
},
"line": {
- "type": "string",
"description": "Line within the source file.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
}
},
- "id": "SourceLocation",
- "description": "Specifies a location in a source code file."
+ "id": "SourceLocation"
},
"ListLogEntriesRequest": {
+ "description": "The parameters to ListLogEntries.",
+ "type": "object",
"properties": {
"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"
},
"resourceNames": {
+ "description": "Required. Names of one or more parent resources from which to retrieve log entries:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nProjects listed in the project_ids field are added to this list.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "Required. Names of one or more parent resources from which to retrieve log entries:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nProjects listed in the project_ids field are added to this list."
+ }
},
"projectIds": {
"description": "Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: \"my-project-1A\". If present, these project identifiers are converted to resource name format and added to the list of resources in resource_names.",
@@ -893,9 +917,7 @@
"type": "integer"
}
},
- "id": "ListLogEntriesRequest",
- "description": "The parameters to ListLogEntries.",
- "type": "object"
+ "id": "ListLogEntriesRequest"
},
"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.",
@@ -932,34 +954,12 @@
"type": "object",
"properties": {},
"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": {
- "description": "Must be greater than 1.",
- "format": "double",
- "type": "number"
- },
- "scale": {
- "description": "Must be greater than 0.",
- "format": "double",
- "type": "number"
- },
- "numFiniteBuckets": {
- "description": "Must be greater than 0.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Exponential"
}
},
"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": "Logging",
"auth": {
@@ -993,164 +993,6 @@
"resources": {
"projects": {
"resources": {
- "metrics": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListLogMetricsResponse"
- },
- "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": {
- "location": "path",
- "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/metrics",
- "path": "v2beta1/{+parent}/metrics",
- "id": "logging.projects.metrics.list",
- "description": "Lists logs-based metrics."
- },
- "get": {
- "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
- "id": "logging.projects.metrics.get",
- "path": "v2beta1/{+metricName}",
- "description": "Gets a logs-based metric.",
- "httpMethod": "GET",
- "parameterOrder": [
- "metricName"
- ],
- "response": {
- "$ref": "LogMetric"
- },
- "parameters": {
- "metricName": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path",
- "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n"
- }
- },
- "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"
- ]
- },
- "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": {
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "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"
- }
- },
- "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.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "metricName"
- ],
- "httpMethod": "DELETE",
- "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 delete:\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.delete"
- }
- }
- },
"logs": {
"methods": {
"delete": {
@@ -1181,18 +1023,18 @@
},
"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",
"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",
- "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."
+ "location": "query"
},
"pageSize": {
"location": "query",
@@ -1215,14 +1057,20 @@
"https://www.googleapis.com/auth/logging.read"
],
"flatPath": "v2beta1/projects/{projectsId}/logs",
- "path": "v2beta1/{+parent}/logs",
- "id": "logging.projects.logs.list"
+ "id": "logging.projects.logs.list",
+ "path": "v2beta1/{+parent}/logs"
}
}
},
"sinks": {
"methods": {
"update": {
+ "path": "v2beta1/{+sinkName}",
+ "id": "logging.projects.sinks.update",
+ "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"
},
@@ -1230,6 +1078,10 @@
"sinkName"
],
"httpMethod": "PUT",
+ "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\".",
@@ -1250,23 +1102,9 @@
"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",
- "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."
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}"
},
"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"
},
@@ -1275,17 +1113,17 @@
],
"httpMethod": "POST",
"parameters": {
+ "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"
+ },
"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": {
- "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": [
@@ -1294,9 +1132,17 @@
],
"flatPath": "v2beta1/projects/{projectsId}/sinks",
"path": "v2beta1/{+parent}/sinks",
- "id": "logging.projects.sinks.create"
+ "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": {
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
+ "path": "v2beta1/{+sinkName}",
+ "id": "logging.projects.sinks.delete",
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
"response": {
"$ref": "Empty"
},
@@ -1316,42 +1162,9 @@
"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.delete",
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted."
+ ]
},
"list": {
- "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 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",
"description": "Lists sinks.",
"response": {
"$ref": "ListSinksResponse"
@@ -1359,7 +1172,36 @@
"parameterOrder": [
"parent"
],
- "httpMethod": "GET"
+ "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"
+ },
+ "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": {
+ "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": "v2beta1/projects/{projectsId}/sinks",
+ "path": "v2beta1/{+parent}/sinks",
+ "id": "logging.projects.sinks.list"
},
"get": {
"response": {
@@ -1377,11 +1219,11 @@
],
"parameters": {
"sinkName": {
+ "pattern": "^projects/[^/]+/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",
- "pattern": "^projects/[^/]+/sinks/[^/]+$"
+ "type": "string"
}
},
"flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
@@ -1390,6 +1232,164 @@
"description": "Gets a sink."
}
}
+ },
+ "metrics": {
+ "methods": {
+ "list": {
+ "description": "Lists logs-based metrics.",
+ "response": {
+ "$ref": "ListLogMetricsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ },
+ "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/projects/{projectsId}/metrics",
+ "path": "v2beta1/{+parent}/metrics",
+ "id": "logging.projects.metrics.list"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "metricName"
+ ],
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "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"
+ }
+ },
+ "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/{metricsId}",
+ "id": "logging.projects.metrics.get",
+ "path": "v2beta1/{+metricName}",
+ "description": "Gets a logs-based metric."
+ },
+ "update": {
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "description": "Creates or updates a logs-based metric.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "metricName"
+ ],
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "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}",
+ "id": "logging.projects.metrics.update",
+ "path": "v2beta1/{+metricName}"
+ },
+ "create": {
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "description": "Creates a logs-based metric.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "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"
+ }
+ },
+ "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",
+ "parameterOrder": [
+ "metricName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "metricName": {
+ "location": "path",
+ "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metrics/[^/]+$"
+ }
+ },
+ "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}"
+ }
+ }
}
}
},
@@ -1405,132 +1405,25 @@
"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": "^billingAccounts/[^/]+/logs/[^/]+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/logging.admin"
],
- "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/[^/]+$"
- }
- },
"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": {
- "id": "logging.billingAccounts.logs.list",
- "path": "v2beta1/{+parent}/logs",
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "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": {
- "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": "^billingAccounts/[^/]+$",
- "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/billingAccounts/{billingAccountsId}/logs"
- }
- }
- }
- }
- },
- "monitoredResourceDescriptors": {
- "methods": {
- "list": {
- "id": "logging.monitoredResourceDescriptors.list",
- "path": "v2beta1/monitoredResourceDescriptors",
- "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": {
- "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/monitoredResourceDescriptors"
- }
- }
- },
- "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.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "httpMethod": "DELETE",
- "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}",
- "path": "v2beta1/{+logName}",
- "id": "logging.organizations.logs.delete"
- },
- "list": {
"description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
"response": {
"$ref": "ListLogsResponse"
@@ -1546,17 +1439,124 @@
"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"
+ "type": "integer",
+ "location": "query"
},
"parent": {
- "pattern": "^organizations/[^/]+$",
+ "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"
+ }
+ },
+ "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/billingAccounts/{billingAccountsId}/logs",
+ "path": "v2beta1/{+parent}/logs",
+ "id": "logging.billingAccounts.logs.list"
+ }
+ }
+ }
+ }
+ },
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "list": {
+ "path": "v2beta1/monitoredResourceDescriptors",
+ "id": "logging.monitoredResourceDescriptors.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",
+ "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"
+ }
+ },
+ "flatPath": "v2beta1/monitoredResourceDescriptors"
+ }
+ }
+ },
+ "organizations": {
+ "resources": {
+ "logs": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2beta1/organizations/{organizationsId}/logs/{logsId}",
+ "id": "logging.organizations.logs.delete",
+ "path": "v2beta1/{+logName}",
+ "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"
+ ],
+ "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"
+ },
+ "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"
+ "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"
}
},
"scopes": [
@@ -1566,8 +1566,8 @@
"https://www.googleapis.com/auth/logging.read"
],
"flatPath": "v2beta1/organizations/{organizationsId}/logs",
- "path": "v2beta1/{+parent}/logs",
- "id": "logging.organizations.logs.list"
+ "id": "logging.organizations.logs.list",
+ "path": "v2beta1/{+parent}/logs"
}
}
}
@@ -1576,38 +1576,38 @@
"entries": {
"methods": {
"list": {
+ "flatPath": "v2beta1/entries:list",
+ "id": "logging.entries.list",
+ "path": "v2beta1/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"
},
- "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",
- "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."
+ ]
},
"write": {
- "path": "v2beta1/entries:write",
"id": "logging.entries.write",
+ "path": "v2beta1/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.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "WriteLogEntriesResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
@@ -1620,17 +1620,46 @@
}
},
"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": {
+ "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": {
- "type": "string",
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response."
- },
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1639,9 +1668,7 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
+ ]
},
"callback": {
"description": "JSONP",
@@ -1649,12 +1676,6 @@
"location": "query"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -1662,11 +1683,12 @@
],
"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.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string"
},
"access_token": {
@@ -1674,36 +1696,14 @@
"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": {
"type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "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"
}
},
diff --git a/manufacturers/v1/manufacturers-api.json b/manufacturers/v1/manufacturers-api.json
index b6ffb3a..98d7a5a 100644
--- a/manufacturers/v1/manufacturers-api.json
+++ b/manufacturers/v1/manufacturers-api.json
@@ -1,19 +1,4 @@
{
- "canonicalName": "Manufacturer Center",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/manufacturercenter": {
- "description": "Manage your product listings for Google Manufacturer Center"
- }
- }
- }
- },
- "rootUrl": "https://manufacturers.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "manufacturers",
- "batchPath": "batch",
- "title": "Manufacturer Center API",
"ownerName": "Google",
"resources": {
"accounts": {
@@ -21,10 +6,7 @@
"products": {
"methods": {
"delete": {
- "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
- "path": "v1/{+parent}/products/{+name}",
- "id": "manufacturers.accounts.products.delete",
- "description": "Deletes the product from a Manufacturer Center account.",
+ "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
@@ -32,10 +14,6 @@
"parent",
"name"
],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
"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.",
@@ -51,7 +29,14 @@
"pattern": "^accounts/[^/]+$",
"location": "path"
}
- }
+ },
+ "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": {
"response": {
@@ -61,9 +46,6 @@
"parent"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
"parameters": {
"pageToken": {
"description": "The token returned by the previous request.",
@@ -71,10 +53,10 @@
"location": "query"
},
"pageSize": {
+ "location": "query",
"description": "Maximum number of product statuses to return in the response, used for\npaging.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"parent": {
"description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
@@ -84,6 +66,9 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ],
"flatPath": "v1/accounts/{accountsId}/products",
"path": "v1/{+parent}/products",
"id": "manufacturers.accounts.products.list",
@@ -113,27 +98,30 @@
"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",
- "pattern": "^accounts/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"flatPath": "v1/accounts/{accountsId}/products/{productsId}"
},
"update": {
- "response": {
+ "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"
],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
+ "response": {
+ "$ref": "Product"
+ },
"parameters": {
"parent": {
"pattern": "^accounts/[^/]+$",
@@ -143,20 +131,17 @@
"type": "string"
},
"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",
- "pattern": "^[^/]+$"
+ "type": "string"
}
},
- "flatPath": "v1/accounts/{accountsId}/products/{productsId}",
- "path": "v1/{+parent}/products/{+name}",
- "id": "manufacturers.accounts.products.update",
- "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.",
- "request": {
- "$ref": "Product"
- }
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ],
+ "flatPath": "v1/accounts/{accountsId}/products/{productsId}"
}
}
}
@@ -164,28 +149,66 @@
}
},
"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": {
+ "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"
+ },
"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": {
"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"
@@ -194,16 +217,14 @@
"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",
@@ -212,43 +233,7 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "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": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
+ "default": "json"
}
},
"version": "v1",
@@ -257,13 +242,14 @@
"description": "Public API for managing Manufacturer Center related data.",
"servicePath": "",
"basePath": "",
- "revision": "20171207",
- "documentationLink": "https://developers.google.com/manufacturers/",
"id": "manufacturers:v1",
+ "documentationLink": "https://developers.google.com/manufacturers/",
+ "revision": "20171207",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"ListProductsResponse": {
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "The token for the retrieval of the next page of product statuses.",
@@ -277,11 +263,16 @@
}
}
},
- "id": "ListProductsResponse",
- "type": "object"
+ "id": "ListProductsResponse"
},
"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"
@@ -289,24 +280,14 @@
"attributeName": {
"description": "The name of the attribute.",
"type": "string"
- },
- "attributeValue": {
- "description": "The value of the attribute.",
- "type": "string"
}
},
- "id": "ProductDetail",
- "description": "A product detail of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.",
- "type": "object"
+ "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": {
- "headline": {
- "description": "A short description of the feature.",
- "type": "string"
- },
"text": {
"description": "A detailed description of the feature.",
"type": "string"
@@ -314,20 +295,18 @@
"image": {
"$ref": "Image",
"description": "An optional image describing the feature."
+ },
+ "headline": {
+ "description": "A short description of the feature.",
+ "type": "string"
}
},
"id": "FeatureDescription"
},
"Issue": {
+ "description": "Product issue.",
+ "type": "object",
"properties": {
- "description": {
- "description": "Description of the issue.",
- "type": "string"
- },
- "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"
@@ -352,17 +331,23 @@
],
"description": "The severity of the issue.",
"type": "string"
+ },
+ "description": {
+ "description": "Description of the issue.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The server-generated type of the issue, for example,\n“INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.",
+ "type": "string"
}
},
- "id": "Issue",
- "description": "Product issue.",
- "type": "object"
+ "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 `{}`.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
},
"Price": {
"description": "A price.",
@@ -383,11 +368,40 @@
"description": "An image.",
"type": "object",
"properties": {
+ "type": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "CRAWLED",
+ "UPLOADED"
+ ],
+ "description": "The type of the image, i.e., crawled or uploaded.\n@OutputOnly",
+ "type": "string",
+ "enumDescriptions": [
+ "Type is unspecified. Should not be used.",
+ "The image was crawled from a provided URL.",
+ "The image was uploaded."
+ ]
+ },
"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",
@@ -404,57 +418,15 @@
"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": {
- "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"
}
},
"id": "Image"
},
"Attributes": {
+ "description": "Attributes of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116.",
+ "type": "object",
"properties": {
- "pattern": {
- "description": "The pattern of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#pattern.",
- "type": "string"
- },
- "imageLink": {
- "description": "The image of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#image.",
- "$ref": "Image"
- },
- "productType": {
- "description": "The type or category of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#producttype.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"format": {
"description": "The format of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#format.",
"type": "string"
@@ -524,8 +496,8 @@
"description": "The scent of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#scent.",
"type": "string"
},
- "flavor": {
- "description": "The flavor of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#flavor.",
+ "ageGroup": {
+ "description": "The target age group of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#agegroup.",
"type": "string"
},
"productDetail": {
@@ -535,22 +507,26 @@
"$ref": "ProductDetail"
}
},
- "ageGroup": {
- "description": "The target age group of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#agegroup.",
- "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.",
+ "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",
@@ -558,17 +534,13 @@
"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"
},
"capacity": {
- "description": "The capacity of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.",
- "$ref": "Capacity"
+ "$ref": "Capacity",
+ "description": "The capacity of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity."
},
"description": {
"description": "The description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#description.",
@@ -589,15 +561,26 @@
"targetClientId": {
"description": "The target client id. Should only be used in the accounts of the data\npartners.",
"type": "string"
+ },
+ "pattern": {
+ "description": "The pattern of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#pattern.",
+ "type": "string"
+ },
+ "imageLink": {
+ "$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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
- "id": "Attributes",
- "description": "Attributes of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116.",
- "type": "object"
+ "id": "Attributes"
},
"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.",
@@ -609,43 +592,20 @@
"type": "string"
}
},
- "id": "Count"
+ "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"
},
"Product": {
"description": "Product data.",
"type": "object",
"properties": {
- "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": {
- "$ref": "Attributes",
- "description": "Attributes of the product provided manually via the Manufacturer Center UI.\n@OutputOnly"
- },
- "targetCountry": {
- "description": "The target country of the product as a CLDR territory code (for example,\nUS).\n@OutputOnly",
- "type": "string"
- },
- "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"
- },
- "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",
+ "items": {
+ "$ref": "Issue"
+ }
},
"manuallyDeletedAttributes": {
"description": "Names of the attributes of the product deleted manually via the\nManufacturer Center UI.\n@OutputOnly",
@@ -654,17 +614,44 @@
"type": "string"
}
},
- "issues": {
- "description": "A server-generated list of issues associated with the product.\n@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "Issue"
- }
+ "finalAttributes": {
+ "$ref": "Attributes",
+ "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"
+ },
+ "productId": {
+ "description": "The ID of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly",
+ "type": "string"
+ },
+ "uploadedAttributes": {
+ "$ref": "Attributes",
+ "description": "Attributes of the product uploaded via the Manufacturer Center API or via\nfeeds."
+ },
+ "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"
},
"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.",
@@ -676,14 +663,27 @@
"type": "string"
}
},
- "id": "Capacity",
- "description": "The capacity of a product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.",
- "type": "object"
+ "id": "Capacity"
}
},
- "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": "Manufacturer Center",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/manufacturercenter": {
+ "description": "Manage your product listings for Google Manufacturer Center"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://manufacturers.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "manufacturers",
+ "batchPath": "batch",
+ "title": "Manufacturer Center API"
}
diff --git a/ml/v1/ml-api.json b/ml/v1/ml-api.json
index 1e7fff0..a942e99 100644
--- a/ml/v1/ml-api.json
+++ b/ml/v1/ml-api.json
@@ -1,23 +1,1200 @@
{
+ "resources": {
+ "projects": {
+ "methods": {
+ "getConfig": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleCloudMlV1__GetConfigResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The project name."
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}:getConfig",
+ "id": "ml.projects.getConfig",
+ "path": "v1/{+name}: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."
+ },
+ "predict": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "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/.+$"
+ }
+ },
+ "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. For details of the format, see the **guide to the\n[predict request format](/ml-engine/docs/v1/predict-request)**.",
+ "request": {
+ "$ref": "GoogleCloudMlV1__PredictRequest"
+ },
+ "response": {
+ "$ref": "GoogleApi__HttpBody"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST"
+ }
+ },
+ "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": "GoogleLongrunning__ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation's parent resource.",
+ "required": true,
+ "type": "string",
+ "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",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/operations",
+ "path": "v1/{+name}/operations",
+ "id": "ml.projects.operations.list"
+ },
+ "get": {
+ "response": {
+ "$ref": "GoogleLongrunning__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/[^/]+/operations/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "ml.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."
+ },
+ "cancel": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleProtobuf__Empty"
+ },
+ "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",
+ "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": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted."
+ }
+ },
+ "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": {
+ "resources": {
+ "versions": {
+ "methods": {
+ "setDefault": {
+ "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.",
+ "request": {
+ "$ref": "GoogleCloudMlV1__SetDefaultVersionRequest"
+ },
+ "response": {
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "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)."
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault",
+ "path": "v1/{+name}:setDefault",
+ "id": "ml.projects.models.versions.setDefault"
+ },
+ "delete": {
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
+ "path": "v1/{+name}",
+ "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.",
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the version. You can get the names of all the\nversions 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/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "list": {
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListVersionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The name of the model for which to list the version.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$"
+ },
+ "filter": {
+ "location": "query",
+ "description": "Optional. Specifies the subset of versions to retrieve.",
+ "type": "string"
+ },
+ "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 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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
+ "path": "v1/{+parent}/versions",
+ "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 a lot of 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):"
+ },
+ "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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The name of the model.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
+ "id": "ml.projects.models.versions.create",
+ "path": "v1/{+parent}/versions"
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameters": {
+ "updateMask": {
+ "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`.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the model."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
+ "id": "ml.projects.models.versions.patch",
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "description": "Updates the specified Version resource.\n\nCurrently the only supported field to update is `description`."
+ },
+ "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",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the version."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.models.versions.get"
+ }
+ }
+ }
+ },
+ "methods": {
+ "getIamPolicy": {
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}:getIamPolicy",
+ "id": "ml.projects.models.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": "GoogleIamV1__Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the model.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "patch": {
+ "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"
+ },
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path",
+ "description": "Required. The project name."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
+ "id": "ml.projects.models.patch",
+ "path": "v1/{+name}",
+ "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`.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ }
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "GoogleIamV1__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/[^/]+/models/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}: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."
+ },
+ "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": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the model."
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.models.delete"
+ },
+ "list": {
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListModelsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "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": {
+ "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"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The name of the project whose models are to be listed.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ },
+ "filter": {
+ "location": "query",
+ "description": "Optional. Specifies the subset of models to retrieve.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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."
+ },
+ "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": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The project name.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models",
+ "path": "v1/{+parent}/models",
+ "id": "ml.projects.models.create"
+ },
+ "setIamPolicy": {
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "ml.projects.models.setIamPolicy",
+ "request": {
+ "$ref": "GoogleIamV1__SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "response": {
+ "$ref": "GoogleIamV1__Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "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}/models/{modelsId}:setIamPolicy"
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "get": {
+ "description": "Get the complete list of CMLE capabilities in a location, along with their\nlocation-specific properties.",
+ "response": {
+ "$ref": "GoogleCloudMlV1__Location"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. The name of the location.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.locations.get"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "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",
+ "location": "query"
+ },
+ "parent": {
+ "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": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations",
+ "id": "ml.projects.locations.list",
+ "path": "v1/{+parent}/locations",
+ "description": "List all locations that provides at least one type of CMLE capability."
+ }
+ }
+ },
+ "jobs": {
+ "methods": {
+ "list": {
+ "description": "Lists the jobs in the project.",
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListJobsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the project for which to list jobs."
+ },
+ "filter": {
+ "description": "Optional. Specifies the subset of jobs to retrieve.",
+ "type": "string",
+ "location": "query"
+ },
+ "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 jobs 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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/jobs",
+ "path": "v1/{+parent}/jobs",
+ "id": "ml.projects.jobs.list"
+ },
+ "setIamPolicy": {
+ "response": {
+ "$ref": "GoogleIamV1__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/[^/]+/jobs/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "ml.projects.jobs.setIamPolicy",
+ "request": {
+ "$ref": "GoogleIamV1__SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ },
+ "create": {
+ "response": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The project name.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/jobs",
+ "path": "v1/{+parent}/jobs",
+ "id": "ml.projects.jobs.create",
+ "description": "Creates a training or a batch prediction job.",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Job"
+ }
+ },
+ "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": {
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the job to cancel.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "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",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "GoogleIamV1__Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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/[^/]+/jobs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:getIamPolicy",
+ "id": "ml.projects.jobs.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy"
+ },
+ "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"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The job name.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path"
+ },
+ "updateMask": {
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.jobs.patch"
+ },
+ "get": {
+ "description": "Describes a job.",
+ "response": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the job to get the description of."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.jobs.get"
+ },
+ "testIamPermissions": {
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "ml.projects.jobs.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": "GoogleIamV1__TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "GoogleIamV1__TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:testIamPermissions"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "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": {
+ "type": "boolean",
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth bearer token."
+ },
+ "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": {
+ "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://ml.googleapis.com/",
+ "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/",
+ "revision": "20171208",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "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": {
+ "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": "GoogleIamV1__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": "GoogleIamV1__Binding"
+ }
+ }
+ },
+ "id": "GoogleIamV1__Policy"
+ },
+ "GoogleLongrunning__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": "GoogleLongrunning__Operation"
+ }
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleLongrunning__ListOperationsResponse"
+ },
+ "GoogleCloudMlV1__ManualScaling": {
+ "description": "Options for manually scaling a model.",
+ "type": "object",
+ "properties": {
+ "nodes": {
+ "description": "The number of nodes to allocate for this model. These nodes are always up,\nstarting from the time the model is deployed, so the cost of operating\nthis model will be proportional to `nodes` * number of hours since\nlast billing cycle plus the cost for each prediction performed.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleCloudMlV1__ManualScaling"
+ },
+ "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"
+ }
+ },
+ "completedTrialCount": {
+ "description": "The number of hyperparameter tuning trials that completed successfully.\nOnly set for hyperparameter tuning jobs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "isHyperparameterTuningJob": {
+ "description": "Whether this job is a hyperparameter tuning job.",
+ "type": "boolean"
+ },
+ "consumedMLUnits": {
+ "description": "The amount of ML units consumed by the job.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "GoogleCloudMlV1__TrainingOutput"
+ },
+ "GoogleIamV1__Binding": {
+ "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",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "type": "string",
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired"
+ }
+ },
+ "id": "GoogleIamV1__Binding",
+ "description": "Associates `members` with a `role`."
+ },
+ "GoogleCloudMlV1__PredictRequest": {
+ "properties": {
+ "httpBody": {
+ "description": "\nRequired. The prediction request body.",
+ "$ref": "GoogleApi__HttpBody"
+ }
+ },
+ "id": "GoogleCloudMlV1__PredictRequest",
+ "description": "Request for predictions to be issued against a trained model.",
+ "type": "object"
+ },
+ "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric": {
+ "description": "An observed value of a metric.",
+ "type": "object",
+ "properties": {
+ "trainingStep": {
+ "description": "The global training step for this metric.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectiveValue": {
+ "description": "The objective value at this training step.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "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": {
+ "state": {
+ "enumDescriptions": [
+ "The version state is unspecified.",
+ "The version is ready for prediction.",
+ "The version is in the process of creation.",
+ "The version failed to be created, possibly cancelled.\n`error_message` should contain the details of the failure.",
+ "The version is in the process of deletion."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "READY",
+ "CREATING",
+ "FAILED",
+ "DELETING"
+ ],
+ "description": "Output only. The state of a version.",
+ "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."
+ },
+ "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": {
- "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"
+ "$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."
},
"createTime": {
"description": "Output only. The time the version was created.",
@@ -25,11 +1202,11 @@
"type": "string"
},
"labels": {
+ "type": "object",
"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"
+ "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."
},
"errorMessage": {
"description": "Output only. The details of a failure or a cancellation.",
@@ -51,32 +1228,6 @@
"isDefault": {
"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": {
- "enumDescriptions": [
- "The version state is unspecified.",
- "The version is ready for prediction.",
- "The version is in the process of creation.",
- "The version failed to be created, possibly cancelled.\n`error_message` should contain the details of the failure.",
- "The version is in the process of deletion."
- ],
- "enum": [
- "UNKNOWN",
- "READY",
- "CREATING",
- "FAILED",
- "DELETING"
- ],
- "description": "Output only. The state of a version.",
- "type": "string"
- },
- "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"
}
},
"id": "GoogleCloudMlV1__Version"
@@ -85,17 +1236,6 @@
"description": "Represents a single hyperparameter to optimize.",
"type": "object",
"properties": {
- "categoricalValues": {
- "description": "Required if type is `CATEGORICAL`. The list of possible categories.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "parameterName": {
- "description": "Required. The parameter name must be unique amongst all ParameterConfigs in\na HyperparameterSpec message. E.g., \"learning_rate\".",
- "type": "string"
- },
"minValue": {
"description": "Required if type is `DOUBLE` or `INTEGER`. This field\nshould be unset if type is `CATEGORICAL`. This value should be integers if\ntype is INTEGER.",
"format": "double",
@@ -110,12 +1250,6 @@
}
},
"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": [
@@ -123,6 +1257,12 @@
"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": {
@@ -147,30 +1287,72 @@
],
"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"
+ }
+ },
+ "parameterName": {
+ "type": "string",
+ "description": "Required. The parameter name must be unique amongst all ParameterConfigs in\na HyperparameterSpec message. E.g., \"learning_rate\"."
}
},
"id": "GoogleCloudMlV1__ParameterSpec"
},
- "GoogleCloudMlV1__Location": {
- "properties": {
- "name": {
- "type": "string"
- },
- "capabilities": {
- "description": "Capabilities available in the location.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudMlV1__Capability"
- }
- }
- },
- "id": "GoogleCloudMlV1__Location",
- "type": "object"
- },
"GoogleCloudMlV1__PredictionInput": {
"description": "Represents input parameters for a prediction job.",
"type": "object",
"properties": {
+ "region": {
+ "type": "string",
+ "description": "Required. The Google Compute Engine region to run the prediction job in."
+ },
+ "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"
+ },
+ "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\"`",
+ "type": "string"
+ },
+ "outputPath": {
+ "description": "Required. The output Google Cloud Storage location.",
+ "type": "string"
+ },
+ "uri": {
+ "type": "string",
+ "description": "Use this field if you want to specify a Google Cloud Storage path for\nthe model to use."
+ },
+ "maxWorkerCount": {
+ "description": "Optional. The maximum number of workers to be used for parallel processing.\nDefaults to 10 if not specified.",
+ "format": "int64",
+ "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.",
+ "Deprecated. Use JSON instead.",
+ "INPUT ONLY. The source file is a TFRecord file.",
+ "INPUT ONLY. The source file is a GZIP-compressed TFRecord file."
+ ],
+ "enum": [
+ "DATA_FORMAT_UNSPECIFIED",
+ "JSON",
+ "TEXT",
+ "TF_RECORD",
+ "TF_RECORD_GZIP"
+ ]
+ },
"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"
@@ -186,59 +1368,53 @@
"items": {
"type": "string"
}
- },
- "region": {
- "description": "Required. The Google Compute Engine region to run the prediction job in.",
- "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"
- },
- "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\"`",
- "type": "string"
- },
- "outputPath": {
- "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"
- },
- "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": {
- "enumDescriptions": [
- "Unspecified format.",
- "Each line of the file is a JSON dictionary representing one record.",
- "Deprecated. Use JSON instead.",
- "INPUT ONLY. The source file is a TFRecord file.",
- "INPUT ONLY. The source file is a GZIP-compressed TFRecord file."
- ],
- "enum": [
- "DATA_FORMAT_UNSPECIFIED",
- "JSON",
- "TEXT",
- "TF_RECORD",
- "TF_RECORD_GZIP"
- ],
- "description": "Required. The format of the input data files.",
- "type": "string"
}
},
"id": "GoogleCloudMlV1__PredictionInput"
},
+ "GoogleCloudMlV1__Location": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "capabilities": {
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudMlV1__Capability"
+ },
+ "description": "Capabilities available in the location."
+ }
+ },
+ "id": "GoogleCloudMlV1__Location"
+ },
"GoogleCloudMlV1__OperationMetadata": {
"properties": {
+ "labels": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The user labels, inherited from the model or the model version being\noperated on."
+ },
+ "createTime": {
+ "description": "The time the operation was submitted.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "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": {
"enumDescriptions": [
"Unspecified operation type.",
@@ -274,31 +1450,6 @@
"isCancellationRequested": {
"description": "Indicates whether a request to cancel this operation has been made.",
"type": "boolean"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The user labels, inherited from the model or the model version being\noperated on.",
- "type": "object"
- },
- "createTime": {
- "description": "The time the operation was submitted.",
- "format": "google-datetime",
- "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"
}
},
"id": "GoogleCloudMlV1__OperationMetadata",
@@ -306,6 +1457,8 @@
"type": "object"
},
"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": {
"description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
@@ -315,6 +1468,12 @@
}
},
"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",
@@ -322,31 +1481,16 @@
"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"
- ]
+ "type": "string"
}
},
- "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.",
- "type": "object"
+ "id": "GoogleIamV1__AuditLogConfig"
},
"GoogleType__Expr": {
+ "id": "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"
@@ -354,18 +1498,24 @@
"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"
+ }
},
"GoogleCloudMlV1__HyperparameterSpec": {
+ "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.",
@@ -375,9 +1525,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.",
@@ -394,46 +1542,49 @@
"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",
- "description": "Represents a set of hyperparameters to optimize.",
- "type": "object"
+ "id": "GoogleCloudMlV1__HyperparameterSpec"
},
"GoogleCloudMlV1__ListLocationsResponse": {
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
- "type": "string"
- },
"locations": {
"description": "Locations where at least one type of CMLE capability is available.",
"type": "array",
"items": {
"$ref": "GoogleCloudMlV1__Location"
}
+ },
+ "nextPageToken": {
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
+ "type": "string"
}
},
"id": "GoogleCloudMlV1__ListLocationsResponse"
},
"GoogleCloudMlV1__ListJobsResponse": {
+ "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": {
+ "type": "string",
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call."
}
},
"id": "GoogleCloudMlV1__ListJobsResponse",
- "description": "Response message for the ListJobs method.",
- "type": "object"
+ "description": "Response message for the ListJobs method."
},
"GoogleCloudMlV1__SetDefaultVersionRequest": {
"description": "Request message for the SetDefaultVersion request.",
@@ -443,22 +1594,6 @@
},
"GoogleLongrunning__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": "GoogleRpc__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.",
@@ -470,12 +1605,70 @@
"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": "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"
},
+ "GoogleCloudMlV1__Model": {
+ "properties": {
+ "description": {
+ "description": "Optional. The description specified for the model when it was created.",
+ "type": "string"
+ },
+ "onlinePredictionLogging": {
+ "type": "boolean",
+ "description": "Optional. If true, enables StackDriver Logging for online prediction.\nDefault is false."
+ },
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a model from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform model updates in order to avoid race\nconditions: An `etag` is returned in the response to `GetModel`, and\nsystems are expected to put that etag in the request to `UpdateModel` to\nensure that their change will be applied to the model as intended.",
+ "format": "byte",
+ "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"
+ }
+ },
+ "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)."
+ },
+ "regions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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.\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."
+ }
+ },
+ "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"
+ },
"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.",
"type": "object",
@@ -500,48 +1693,6 @@
},
"id": "GoogleIamV1__AuditConfig"
},
- "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",
- "properties": {
- "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)."
- },
- "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.\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",
- "items": {
- "type": "string"
- }
- },
- "description": {
- "description": "Optional. The description specified for the model when it was created.",
- "type": "string"
- },
- "onlinePredictionLogging": {
- "description": "Optional. If true, enables StackDriver Logging for online prediction.\nDefault is false.",
- "type": "boolean"
- },
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a model from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform model updates in order to avoid race\nconditions: An `etag` is returned in the response to `GetModel`, and\nsystems are expected to put that etag in the request to `UpdateModel` to\nensure that their change will be applied to the model as intended.",
- "format": "byte",
- "type": "string"
- },
- "labels": {
- "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"
- }
- },
- "id": "GoogleCloudMlV1__Model"
- },
"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",
@@ -549,26 +1700,14 @@
"id": "GoogleProtobuf__Empty"
},
"GoogleCloudMlV1__CancelJobRequest": {
- "properties": {},
- "id": "GoogleCloudMlV1__CancelJobRequest",
"description": "Request message for the CancelJob method.",
- "type": "object"
- },
- "GoogleIamV1__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": "GoogleIamV1__TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "GoogleCloudMlV1__CancelJobRequest"
},
"GoogleCloudMlV1__ListVersionsResponse": {
+ "description": "Response message for the ListVersions method.",
+ "type": "object",
"properties": {
"versions": {
"description": "The list of versions.",
@@ -582,11 +1721,24 @@
"type": "string"
}
},
- "id": "GoogleCloudMlV1__ListVersionsResponse",
- "description": "Response message for the ListVersions method.",
- "type": "object"
+ "id": "GoogleCloudMlV1__ListVersionsResponse"
+ },
+ "GoogleIamV1__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": "GoogleIamV1__TestIamPermissionsRequest"
},
"GoogleCloudMlV1__AutoScaling": {
+ "type": "object",
"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.",
@@ -595,19 +1747,13 @@
}
},
"id": "GoogleCloudMlV1__AutoScaling",
- "description": "Options for automatically scaling a model.",
- "type": "object"
+ "description": "Options for automatically scaling a model."
},
"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": {
- "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": {
@@ -615,12 +1761,17 @@
"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."
},
"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"
@@ -645,17 +1796,64 @@
},
"GoogleCloudMlV1__TrainingInput": {
"properties": {
+ "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"
+ },
+ "pythonModule": {
+ "description": "Required. The Python module name to run after installing the packages.",
+ "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.",
+ "type": "string"
+ },
+ "args": {
+ "description": "Optional. Command line arguments to pass to the program.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "region": {
+ "description": "Required. The Google Compute Engine region to run the training job in.",
+ "type": "string"
+ },
+ "parameterServerType": {
+ "description": "Optional. Specifies the type of virtual machine to use for your training\njob's parameter server.\n\nThe supported values are the same as those described in the entry for\n`master_type`.\n\nThis value must be present when `scaleTier` is set to `CUSTOM` and\n`parameter_server_count` is greater than zero.",
+ "type": "string"
+ },
+ "scaleTier": {
+ "enum": [
+ "BASIC",
+ "STANDARD_1",
+ "PREMIUM_1",
+ "BASIC_GPU",
+ "BASIC_TPU",
+ "CUSTOM"
+ ],
+ "description": "Required. Specifies the machine types, the number of replicas for workers\nand parameter servers.",
+ "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.",
"type": "string"
},
"hyperparameters": {
- "description": "Optional. The set of Hyperparameters to tune.",
- "$ref": "GoogleCloudMlV1__HyperparameterSpec"
+ "$ref": "GoogleCloudMlV1__HyperparameterSpec",
+ "description": "Optional. The set of Hyperparameters to tune."
},
"pythonVersion": {
- "description": "Optional. The version of Python used in training. If not set, the default\nversion is '2.7'.",
- "type": "string"
+ "type": "string",
+ "description": "Optional. The version of Python used in training. If not set, the default\nversion is '2.7'."
},
"parameterServerCount": {
"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`.",
@@ -675,55 +1873,8 @@
"type": "string"
},
"masterType": {
- "description": "Optional. Specifies the type of virtual machine to use for your training\njob's master worker.\n\nThe following types are supported:\n\n\u003cdl\u003e\n \u003cdt\u003estandard\u003c/dt\u003e\n \u003cdd\u003e\n A basic machine configuration suitable for training simple models with\n small to moderate datasets.\n \u003c/dd\u003e\n \u003cdt\u003elarge_model\u003c/dt\u003e\n \u003cdd\u003e\n A machine with a lot of memory, specially suited for parameter servers\n when your model is large (having many hidden layers or layers with very\n large numbers of nodes).\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_s\u003c/dt\u003e\n \u003cdd\u003e\n A machine suitable for the master and workers of the cluster when your\n model requires more computation than the standard machine can handle\n satisfactorily.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_s\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_l\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003estandard_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to \u003ccode suppresswarning=\"true\"\u003estandard\u003c/code\u003e that\n also includes a single NVIDIA Tesla K80 GPU. See more about\n \u003ca href=\"/ml-engine/docs/how-tos/using-gpus\"\u003e\n using GPUs for training your model\u003c/a\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to\n \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e that also includes\n four NVIDIA Tesla K80 GPUs.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_l_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to\n \u003ccode suppresswarning=\"true\"\u003ecomplex_model_l\u003c/code\u003e that also includes\n eight NVIDIA Tesla K80 GPUs.\n \u003c/dd\u003e\n \u003cdt\u003estandard_p100\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to \u003ccode suppresswarning=\"true\"\u003estandard\u003c/code\u003e that\n also includes a single NVIDIA Tesla P100 GPU. The availability of these\n GPUs is in the Alpha launch stage.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m_p100\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to\n \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e that also includes\n four NVIDIA Tesla P100 GPUs. The availability of these GPUs is in\n the Alpha launch stage.\n \u003c/dd\u003e\n\u003c/dl\u003e\n\nYou must set this value when `scaleTier` is set to `CUSTOM`.",
- "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"
- },
- "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.",
- "type": "string"
- },
- "args": {
- "description": "Optional. Command line arguments to pass to the program.",
- "type": "array",
- "items": {
- "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.",
- "type": "string"
- },
- "parameterServerType": {
- "description": "Optional. Specifies the type of virtual machine to use for your training\njob's parameter server.\n\nThe supported values are the same as those described in the entry for\n`master_type`.\n\nThis value must be present when `scaleTier` is set to `CUSTOM` and\n`parameter_server_count` is greater than zero.",
- "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",
- "PREMIUM_1",
- "BASIC_GPU",
- "BASIC_TPU",
- "CUSTOM"
- ],
- "description": "Required. Specifies the machine types, the number of replicas for workers\nand parameter servers.",
- "type": "string"
+ "type": "string",
+ "description": "Optional. Specifies the type of virtual machine to use for your training\njob's master worker.\n\nThe following types are supported:\n\n\u003cdl\u003e\n \u003cdt\u003estandard\u003c/dt\u003e\n \u003cdd\u003e\n A basic machine configuration suitable for training simple models with\n small to moderate datasets.\n \u003c/dd\u003e\n \u003cdt\u003elarge_model\u003c/dt\u003e\n \u003cdd\u003e\n A machine with a lot of memory, specially suited for parameter servers\n when your model is large (having many hidden layers or layers with very\n large numbers of nodes).\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_s\u003c/dt\u003e\n \u003cdd\u003e\n A machine suitable for the master and workers of the cluster when your\n model requires more computation than the standard machine can handle\n satisfactorily.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_s\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_l\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003estandard_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to \u003ccode suppresswarning=\"true\"\u003estandard\u003c/code\u003e that\n also includes a single NVIDIA Tesla K80 GPU. See more about\n \u003ca href=\"/ml-engine/docs/how-tos/using-gpus\"\u003e\n using GPUs for training your model\u003c/a\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to\n \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e that also includes\n four NVIDIA Tesla K80 GPUs.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_l_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to\n \u003ccode suppresswarning=\"true\"\u003ecomplex_model_l\u003c/code\u003e that also includes\n eight NVIDIA Tesla K80 GPUs.\n \u003c/dd\u003e\n \u003cdt\u003estandard_p100\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to \u003ccode suppresswarning=\"true\"\u003estandard\u003c/code\u003e that\n also includes a single NVIDIA Tesla P100 GPU. The availability of these\n GPUs is in the Alpha launch stage.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m_p100\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to\n \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e that also includes\n four NVIDIA Tesla P100 GPUs. The availability of these GPUs is in\n the Alpha launch stage.\n \u003c/dd\u003e\n\u003c/dl\u003e\n\nYou must set this value when `scaleTier` is set to `CUSTOM`."
}
},
"id": "GoogleCloudMlV1__TrainingInput",
@@ -731,15 +1882,35 @@
"type": "object"
},
"GoogleCloudMlV1__Job": {
+ "description": "Represents a training or prediction job.",
+ "type": "object",
"properties": {
+ "jobId": {
+ "description": "Required. The user-specified id of the job.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Output only. When the job processing was completed.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Output only. When the job processing was started.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "predictionOutput": {
+ "$ref": "GoogleCloudMlV1__PredictionOutput",
+ "description": "The current prediction job result."
+ },
"trainingOutput": {
"$ref": "GoogleCloudMlV1__TrainingOutput",
"description": "The current training job result."
},
"createTime": {
+ "type": "string",
"description": "Output only. When the job was created.",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
},
"labels": {
"additionalProperties": {
@@ -749,8 +1920,8 @@
"type": "object"
},
"predictionInput": {
- "description": "Input parameters to create a prediction job.",
- "$ref": "GoogleCloudMlV1__PredictionInput"
+ "$ref": "GoogleCloudMlV1__PredictionInput",
+ "description": "Input parameters to create a prediction job."
},
"errorMessage": {
"description": "Output only. The details of a failure or a cancellation.",
@@ -762,8 +1933,8 @@
"type": "string"
},
"trainingInput": {
- "description": "Input parameters to create a training job.",
- "$ref": "GoogleCloudMlV1__TrainingInput"
+ "$ref": "GoogleCloudMlV1__TrainingInput",
+ "description": "Input parameters to create a training job."
},
"state": {
"enumDescriptions": [
@@ -788,58 +1959,38 @@
],
"description": "Output only. The detailed state of a job.",
"type": "string"
- },
- "jobId": {
- "description": "Required. The user-specified id of the job.",
- "type": "string"
- },
- "endTime": {
- "description": "Output only. When the job processing was completed.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "Output only. When the job processing was started.",
- "format": "google-datetime",
- "type": "string"
- },
- "predictionOutput": {
- "$ref": "GoogleCloudMlV1__PredictionOutput",
- "description": "The current prediction job result."
}
},
- "id": "GoogleCloudMlV1__Job",
- "description": "Represents a training or prediction job.",
- "type": "object"
+ "id": "GoogleCloudMlV1__Job"
},
"GoogleCloudMlV1__Capability": {
"type": "object",
"properties": {
"type": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "TRAINING",
- "BATCH_PREDICTION",
- "ONLINE_PREDICTION"
- ],
"type": "string",
"enumDescriptions": [
"",
"",
"",
""
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "TRAINING",
+ "BATCH_PREDICTION",
+ "ONLINE_PREDICTION"
]
},
"availableAccelerators": {
"description": "Available accelerators for the capability.",
"type": "array",
"items": {
+ "type": "string",
"enum": [
"ACCELERATOR_TYPE_UNSPECIFIED",
"NVIDIA_TESLA_K80",
"NVIDIA_TESLA_P100"
- ],
- "type": "string"
+ ]
},
"enumDescriptions": [
"Unspecified accelerator type. Default to no GPU.",
@@ -851,7 +2002,21 @@
"id": "GoogleCloudMlV1__Capability"
},
"GoogleApi__HttpBody": {
+ "id": "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",
"properties": {
+ "extensions": {
+ "description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ },
"data": {
"description": "HTTP body binary data.",
"format": "byte",
@@ -860,22 +2025,8 @@
"contentType": {
"description": "The HTTP Content-Type string representing the content type of the body.",
"type": "string"
- },
- "extensions": {
- "description": "Application specific response metadata. Must be set in the first response\nfor streaming APIs.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
}
- },
- "id": "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"
+ }
},
"GoogleCloudMlV1__GetConfigResponse": {
"description": "Returns service account information associated with a project.",
@@ -907,20 +2058,36 @@
},
"id": "GoogleIamV1__TestIamPermissionsResponse"
},
+ "GoogleIamV1__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": "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",
+ "description": "Request message for `SetIamPolicy` 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"
- }
+ },
+ "description": "All recorded object metrics for this trial. This field is not currently\npopulated."
},
"finalMetric": {
- "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric",
- "description": "The final objective metric seen for this trial."
+ "description": "The final objective metric seen for this trial.",
+ "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
},
"hyperparameters": {
"additionalProperties": {
@@ -936,31 +2103,9 @@
},
"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"
- },
"GoogleCloudMlV1__PredictionOutput": {
- "description": "Represents results of a prediction job.",
"type": "object",
"properties": {
- "errorCount": {
- "description": "The number of data instances which resulted in errors.",
- "format": "int64",
- "type": "string"
- },
"outputPath": {
"description": "The output Google Cloud Storage location provided at the job creation time.",
"type": "string"
@@ -974,158 +2119,22 @@
"description": "The number of generated predictions.",
"format": "int64",
"type": "string"
- }
- },
- "id": "GoogleCloudMlV1__PredictionOutput"
- },
- "GoogleIamV1__Policy": {
- "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": "GoogleIamV1__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": "GoogleIamV1__Binding"
- }
- }
- },
- "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"
- },
- "GoogleLongrunning__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": "GoogleLongrunning__Operation"
- }
- }
- },
- "id": "GoogleLongrunning__ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
- },
- "GoogleCloudMlV1__ManualScaling": {
- "description": "Options for manually scaling a model.",
- "type": "object",
- "properties": {
- "nodes": {
- "description": "The number of nodes to allocate for this model. These nodes are always up,\nstarting from the time the model is deployed, so the cost of operating\nthis model will be proportional to `nodes` * number of hours since\nlast billing cycle plus the cost for each prediction performed.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GoogleCloudMlV1__ManualScaling"
- },
- "GoogleIamV1__Binding": {
- "properties": {
- "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."
- },
- "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": "GoogleIamV1__Binding",
- "description": "Associates `members` with a `role`.",
- "type": "object"
- },
- "GoogleCloudMlV1__TrainingOutput": {
- "description": "Represents results of a training job. Output only.",
- "type": "object",
- "properties": {
- "completedTrialCount": {
- "description": "The number of hyperparameter tuning trials that completed successfully.\nOnly set for hyperparameter tuning jobs.",
+ "errorCount": {
+ "description": "The number of data instances which resulted in errors.",
"format": "int64",
"type": "string"
- },
- "isHyperparameterTuningJob": {
- "description": "Whether this job is a hyperparameter tuning job.",
- "type": "boolean"
- },
- "consumedMLUnits": {
- "description": "The amount of ML units consumed by the job.",
- "format": "double",
- "type": "number"
- },
- "trials": {
- "description": "Results for individual Hyperparameter trials.\nOnly set for hyperparameter tuning jobs.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudMlV1__HyperparameterOutput"
- }
}
},
- "id": "GoogleCloudMlV1__TrainingOutput"
- },
- "GoogleCloudMlV1__PredictRequest": {
- "description": "Request for predictions to be issued against a trained model.",
- "type": "object",
- "properties": {
- "httpBody": {
- "$ref": "GoogleApi__HttpBody",
- "description": "\nRequired. The prediction request body."
- }
- },
- "id": "GoogleCloudMlV1__PredictRequest"
- },
- "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric": {
- "description": "An observed value of a metric.",
- "type": "object",
- "properties": {
- "trainingStep": {
- "description": "The global training step for this metric.",
- "format": "int64",
- "type": "string"
- },
- "objectiveValue": {
- "description": "The objective value at this training step.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
+ "id": "GoogleCloudMlV1__PredictionOutput",
+ "description": "Represents results of a prediction job."
}
},
- "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": {
@@ -1142,1014 +2151,5 @@
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Cloud Machine Learning Engine",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "locations": {
- "methods": {
- "get": {
- "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.",
- "response": {
- "$ref": "GoogleCloudMlV1__Location"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the location.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/locations/{locationsId}"
- },
- "list": {
- "response": {
- "$ref": "GoogleCloudMlV1__ListLocationsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "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": {
- "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",
- "location": "query"
- },
- "parent": {
- "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"
- }
- },
- "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."
- }
- }
- },
- "jobs": {
- "methods": {
- "create": {
- "response": {
- "$ref": "GoogleCloudMlV1__Job"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The project name.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/jobs",
- "path": "v1/{+parent}/jobs",
- "id": "ml.projects.jobs.create",
- "description": "Creates a training or a batch prediction job.",
- "request": {
- "$ref": "GoogleCloudMlV1__Job"
- }
- },
- "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": {
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "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/projects/{projectsId}/jobs/{jobsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "ml.projects.jobs.setIamPolicy"
- },
- "cancel": {
- "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"
- ],
- "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."
- },
- "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"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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/[^/]+/jobs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:getIamPolicy"
- },
- "get": {
- "description": "Describes a job.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleCloudMlV1__Job"
- },
- "parameters": {
- "name": {
- "description": "Required. The name of the job to get the description of.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}",
- "id": "ml.projects.jobs.get",
- "path": "v1/{+name}"
- },
- "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"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "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"
- },
- "name": {
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path",
- "description": "Required. The job name.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.jobs.patch"
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "GoogleIamV1__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/[^/]+/jobs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:testIamPermissions",
- "id": "ml.projects.jobs.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions"
- },
- "list": {
- "description": "Lists the jobs in the project.",
- "response": {
- "$ref": "GoogleCloudMlV1__ListJobsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "description": "Required. The name of the project for which to list jobs.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "filter": {
- "description": "Optional. Specifies the subset of jobs 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 jobs 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"
- ],
- "flatPath": "v1/projects/{projectsId}/jobs",
- "path": "v1/{+parent}/jobs",
- "id": "ml.projects.jobs.list"
- }
- }
- },
- "operations": {
- "methods": {
- "cancel": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleProtobuf__Empty"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/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": "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": {
- "pattern": "^projects/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "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`."
- },
- "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": "GoogleLongrunning__ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "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"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/operations",
- "path": "v1/{+name}/operations",
- "id": "ml.projects.operations.list"
- },
- "get": {
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "ml.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."
- }
- }
- },
- "models": {
- "methods": {
- "getIamPolicy": {
- "response": {
- "$ref": "GoogleIamV1__Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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/[^/]+/models/[^/]+$",
- "location": "path"
- }
- },
- "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."
- },
- "get": {
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path",
- "description": "Required. The name of the model.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}"
- },
- "patch": {
- "path": "v1/{+name}",
- "id": "ml.projects.models.patch",
- "description": "Updates a specific model resource.\n\nCurrently the only supported fields to update are `description` and\n`default_version.name`.",
- "request": {
- "$ref": "GoogleCloudMlV1__Model"
- },
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameterOrder": [
- "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"
- },
- "name": {
- "description": "Required. The project name.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}"
- },
- "testIamPermissions": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "GoogleIamV1__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/[^/]+/models/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}:testIamPermissions",
- "id": "ml.projects.models.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."
- },
- "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": {
- "description": "Required. The name of the model.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
- "path": "v1/{+name}",
- "id": "ml.projects.models.delete"
- },
- "list": {
- "response": {
- "$ref": "GoogleCloudMlV1__ListModelsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The name of the project whose models are to be listed.",
- "required": true,
- "type": "string"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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."
- },
- "create": {
- "response": {
- "$ref": "GoogleCloudMlV1__Model"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The project name.",
- "required": true,
- "type": "string"
- }
- },
- "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)."
- },
- "setIamPolicy": {
- "request": {
- "$ref": "GoogleIamV1__SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "response": {
- "$ref": "GoogleIamV1__Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "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}/models/{modelsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "ml.projects.models.setIamPolicy"
- }
- },
- "resources": {
- "versions": {
- "methods": {
- "setDefault": {
- "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.",
- "request": {
- "$ref": "GoogleCloudMlV1__SetDefaultVersionRequest"
- },
- "response": {
- "$ref": "GoogleCloudMlV1__Version"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "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/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault",
- "path": "v1/{+name}:setDefault",
- "id": "ml.projects.models.versions.setDefault"
- },
- "delete": {
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
- "location": "path",
- "description": "Required. The name of the version. You can get the names of all the\nversions of a model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
- "path": "v1/{+name}",
- "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": {
- "path": "v1/{+parent}/versions",
- "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 a lot of 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):",
- "response": {
- "$ref": "GoogleCloudMlV1__ListVersionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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 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"
- },
- "parent": {
- "description": "Required. The name of the model for which to list the version.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path"
- },
- "filter": {
- "description": "Optional. Specifies the subset of versions to retrieve.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions"
- },
- "create": {
- "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"
- },
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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"
- },
- "patch": {
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "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`.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "name": {
- "description": "Required. The name of the model.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
- "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`."
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleCloudMlV1__Version"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
- "location": "path",
- "description": "Required. The name of the version.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
- "id": "ml.projects.models.versions.get",
- "path": "v1/{+name}",
- "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."
- }
- }
- }
- }
- }
- },
- "methods": {
- "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",
- "path": "v1/{+name}:getConfig",
- "id": "ml.projects.getConfig"
- },
- "predict": {
- "path": "v1/{+name}:predict",
- "id": "ml.projects.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. For details of the format, see the **guide to the\n[predict request format](/ml-engine/docs/v1/predict-request)**.",
- "response": {
- "$ref": "GoogleApi__HttpBody"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "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.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}:predict"
- }
- }
- }
- },
- "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"
- },
- "$.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": {
- "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"
- },
- "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"
- }
- },
- "version": "v1",
- "baseUrl": "https://ml.googleapis.com/",
- "servicePath": "",
- "description": "An API to enable creating and using machine learning models.",
- "kind": "discovery#restDescription",
- "basePath": "",
- "id": "ml:v1",
- "documentationLink": "https://cloud.google.com/ml/",
- "revision": "20171208"
+ "ownerName": "Google"
}
diff --git a/monitoring/v3/monitoring-api.json b/monitoring/v3/monitoring-api.json
index 26aab3a..7111c44 100644
--- a/monitoring/v3/monitoring-api.json
+++ b/monitoring/v3/monitoring-api.json
@@ -1,1188 +1,16 @@
{
- "canonicalName": "Monitoring",
- "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/monitoring.read": {
- "description": "View monitoring data for all of your Google Cloud and third-party projects"
- },
- "https://www.googleapis.com/auth/monitoring": {
- "description": "View and write monitoring data for all of your Google and third-party Cloud and API projects"
- },
- "https://www.googleapis.com/auth/monitoring.write": {
- "description": "Publish metric data to your Google Cloud projects"
- }
- }
- }
- },
- "rootUrl": "https://monitoring.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "monitoring",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Stackdriver Monitoring API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "timeSeries": {
- "methods": {
- "list": {
- "description": "Lists time series that match a filter. This method does not require a Stackdriver account.",
- "response": {
- "$ref": "ListTimeSeriesResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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",
- "type": "string",
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "FULL",
- "HEADERS"
- ],
- "description": "Specifies which information is returned about the time series.",
- "type": "string"
- },
- "aggregation.groupByFields": {
- "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,
- "location": "query"
- },
- "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"
- },
- "interval.endTime": {
- "location": "query",
- "description": "Required. The end of the time interval.",
- "format": "google-datetime",
- "type": "string"
- },
- "aggregation.alignmentPeriod": {
- "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",
- "location": "query"
- },
- "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": {
- "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",
- "location": "query"
- },
- "aggregation.crossSeriesReducer": {
- "location": "query",
- "enum": [
- "REDUCE_NONE",
- "REDUCE_MEAN",
- "REDUCE_MIN",
- "REDUCE_MAX",
- "REDUCE_SUM",
- "REDUCE_STDDEV",
- "REDUCE_COUNT",
- "REDUCE_COUNT_TRUE",
- "REDUCE_FRACTION_TRUE",
- "REDUCE_PERCENTILE_99",
- "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": {
- "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",
- "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"
- },
- "aggregation.perSeriesAligner": {
- "location": "query",
- "enum": [
- "ALIGN_NONE",
- "ALIGN_DELTA",
- "ALIGN_RATE",
- "ALIGN_INTERPOLATE",
- "ALIGN_NEXT_OLDER",
- "ALIGN_MIN",
- "ALIGN_MAX",
- "ALIGN_MEAN",
- "ALIGN_COUNT",
- "ALIGN_SUM",
- "ALIGN_STDDEV",
- "ALIGN_COUNT_TRUE",
- "ALIGN_FRACTION_TRUE",
- "ALIGN_PERCENTILE_99",
- "ALIGN_PERCENTILE_95",
- "ALIGN_PERCENTILE_50",
- "ALIGN_PERCENTILE_05"
- ],
- "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.",
- "type": "string"
- }
- },
- "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}/timeSeries",
- "path": "v3/{+name}/timeSeries",
- "id": "monitoring.projects.timeSeries.list"
- },
- "create": {
- "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.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "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}/timeSeries",
- "path": "v3/{+name}/timeSeries",
- "id": "monitoring.projects.timeSeries.create"
- }
- }
- },
- "uptimeCheckConfigs": {
- "methods": {
- "list": {
- "description": "Lists the existing valid uptime check configurations for the project, leaving out any invalid configurations.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListUptimeCheckConfigsResponse"
- },
- "parameters": {
- "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": {
- "description": "The project whose uptime check configurations are listed. The format isprojects/[PROJECT_ID].",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "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"
- }
- },
- "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",
- "id": "monitoring.projects.uptimeCheckConfigs.list",
- "path": "v3/{+parent}/uptimeCheckConfigs"
- },
- "get": {
- "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": {
- "description": "The uptime check configuration to retrieve. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.uptimeCheckConfigs.get",
- "description": "Gets a single uptime check configuration."
- },
- "patch": {
- "response": {
- "$ref": "UptimeCheckConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "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"
- }
- },
- "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.uptimeCheckConfigs.patch",
- "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.",
- "request": {
- "$ref": "UptimeCheckConfig"
- }
- },
- "create": {
- "request": {
- "$ref": "UptimeCheckConfig"
- },
- "description": "Creates a new uptime check configuration.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "UptimeCheckConfig"
- },
- "parameters": {
- "parent": {
- "description": "The project in which to create the uptime check. The format is:projects/[PROJECT_ID].",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "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"
- },
- "delete": {
- "id": "monitoring.projects.uptimeCheckConfigs.delete",
- "path": "v3/{+name}",
- "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.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The uptime check configuration to delete. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
- "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}"
- }
- }
- },
- "monitoredResourceDescriptors": {
- "methods": {
- "list": {
- "description": "Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListMonitoredResourceDescriptorsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "filter": {
- "location": "query",
- "description": "An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label:\nresource.type = starts_with(\"gce_\") AND resource.label:id\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}/monitoredResourceDescriptors",
- "id": "monitoring.projects.monitoredResourceDescriptors.list",
- "path": "v3/{+name}/monitoredResourceDescriptors"
- },
- "get": {
- "description": "Gets a single monitored resource descriptor. This method does not require a Stackdriver account.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "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.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/monitoredResourceDescriptors/[^/]+$",
- "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}/monitoredResourceDescriptors/{monitoredResourceDescriptorsId}",
- "id": "monitoring.projects.monitoredResourceDescriptors.get",
- "path": "v3/{+name}"
- }
- }
- },
- "groups": {
- "methods": {
- "delete": {
- "path": "v3/{+name}",
- "id": "monitoring.projects.groups.delete",
- "description": "Deletes an existing group.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}"
- },
- "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": {
- "name": {
- "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"
- },
- "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": {
- "description": "A positive number that is the maximum number of results to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "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"
- }
- }
- },
- "get": {
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.groups.get",
- "description": "Gets a single group.",
- "response": {
- "$ref": "Group"
- },
- "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": {
- "description": "The group to retrieve. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path"
- }
- }
- },
- "update": {
- "path": "v3/{+name}",
- "id": "monitoring.projects.groups.update",
- "request": {
- "$ref": "Group"
- },
- "description": "Updates an existing group. You can change any group attributes except name.",
- "response": {
- "$ref": "Group"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "location": "path",
- "description": "Output only. The name of this group. The format is \"projects/{project_id_or_number}/groups/{group_id}\". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/groups/[^/]+$"
- },
- "validateOnly": {
- "location": "query",
- "description": "If true, validate this request but do not update the existing group.",
- "type": "boolean"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}"
- },
- "create": {
- "response": {
- "$ref": "Group"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The project in which to create the group. The format is \"projects/{project_id_or_number}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "validateOnly": {
- "description": "If true, validate this request but do not create the group.",
- "type": "boolean",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "flatPath": "v3/projects/{projectsId}/groups",
- "path": "v3/{+name}/groups",
- "id": "monitoring.projects.groups.create",
- "request": {
- "$ref": "Group"
- },
- "description": "Creates a new group."
- }
- },
- "resources": {
- "members": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListGroupMembersResponse"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path",
- "description": "The group whose members are listed. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
- "required": true,
- "type": "string"
- },
- "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"
- },
- "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",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "A positive number that is the maximum number of results to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "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}/members",
- "id": "monitoring.projects.groups.members.list",
- "path": "v3/{+name}/members",
- "description": "Lists the monitored resources that are members of a group."
- }
- }
- }
- }
- },
- "collectdTimeSeries": {
- "methods": {
- "create": {
- "response": {
- "$ref": "CreateCollectdTimeSeriesResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The project in which to create the time series. The format is \"projects/PROJECT_ID_OR_NUMBER\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "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": {
- "delete": {
- "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"
- }
- },
- "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": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListMetricDescriptorsResponse"
- },
- "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": {
- "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/[^/]+$"
- },
- "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": {
- "description": "A positive number that is the maximum number of results to return.",
- "format": "int32",
- "type": "integer",
- "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}/metricDescriptors",
- "id": "monitoring.projects.metricDescriptors.list",
- "path": "v3/{+name}/metricDescriptors",
- "description": "Lists metric descriptors that match a filter. This method does not require a Stackdriver account."
- },
- "get": {
- "response": {
- "$ref": "MetricDescriptor"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.metricDescriptors.get",
- "description": "Gets a single metric descriptor. This method does not require a Stackdriver account."
- },
- "create": {
- "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": {
- "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"
- }
- },
- "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",
- "id": "monitoring.projects.metricDescriptors.create",
- "path": "v3/{+name}/metricDescriptors"
- }
- }
- }
- }
- },
- "uptimeCheckIps": {
- "methods": {
- "list": {
- "description": "Returns the list of IPs that checkers run from",
- "response": {
- "$ref": "ListUptimeCheckIpsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "parameters": {
- "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. NOTE: this field is not yet implemented",
- "format": "int32",
- "type": "integer"
- },
- "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. NOTE: this field is not yet implemented",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v3/uptimeCheckIps",
- "path": "v3/uptimeCheckIps",
- "id": "monitoring.uptimeCheckIps.list"
- }
- }
- }
- },
- "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": {
- "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": {
- "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": {
- "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"
- }
- },
- "version": "v3",
"baseUrl": "https://monitoring.googleapis.com/",
"servicePath": "",
"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.",
"kind": "discovery#restDescription",
"basePath": "",
- "revision": "20171213",
- "documentationLink": "https://cloud.google.com/monitoring/api/",
"id": "monitoring:v3",
+ "documentationLink": "https://cloud.google.com/monitoring/api/",
+ "revision": "20171213",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "CollectdPayloadError": {
- "description": "Describes the error status for payloads that were not written.",
- "type": "object",
- "properties": {
- "index": {
- "description": "The zero-based index in CreateCollectdTimeSeriesRequest.collectd_payloads.",
- "format": "int32",
- "type": "integer"
- },
- "error": {
- "description": "Records the error status for the payload. If this field is present, the partial errors for nested values won't be populated.",
- "$ref": "Status"
- },
- "valueErrors": {
- "description": "Records the error status for values that were not written due to an error.Failed payloads for which nothing is written will not include partial value errors.",
- "type": "array",
- "items": {
- "$ref": "CollectdValueError"
- }
- }
- },
- "id": "CollectdPayloadError"
- },
- "MonitoredResourceDescriptor": {
- "properties": {
- "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"
- },
- "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"
- },
- "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",
- "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"
- },
- "TypedValue": {
- "description": "A single strongly-typed value.",
- "type": "object",
- "properties": {
- "boolValue": {
- "description": "A Boolean value: true or false.",
- "type": "boolean"
- },
- "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": "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": {
- "resourceType": {
- "description": "The resource type of the group members.",
- "type": "string",
- "enumDescriptions": [
- "Default value (not valid).",
- "A group of instances from Google Cloud Platform (GCP) or Amazon Web Services (AWS).",
- "A group of AWS load balancers."
- ],
- "enum": [
- "RESOURCE_TYPE_UNSPECIFIED",
- "INSTANCE",
- "AWS_ELB_LOAD_BALANCER"
- ]
- },
- "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",
- "properties": {
- "error": {
- "description": "Records the error status for the value.",
- "$ref": "Status"
- },
- "index": {
- "description": "The zero-based index in CollectdPayload.values within the parent CreateCollectdTimeSeriesRequest.collectd_payloads.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "CollectdValueError"
- },
- "UptimeCheckIp": {
- "description": "Contains the region, location, and list of IP addresses where checkers in the location run from.",
- "type": "object",
- "properties": {
- "ipAddress": {
- "description": "The IP address from which the uptime check originates. This is a full IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely and should support interpreting this field in either IPv4 or IPv6 format.",
- "type": "string"
- },
- "region": {
- "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)."
- ],
- "enum": [
- "REGION_UNSPECIFIED",
- "USA",
- "EUROPE",
- "SOUTH_AMERICA",
- "ASIA_PACIFIC"
- ],
- "description": "A broad region category in which the IP address is located.",
- "type": "string"
- },
- "location": {
- "description": "A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category.",
- "type": "string"
- }
- },
- "id": "UptimeCheckIp"
- },
- "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"
- },
- "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"
- },
- "endTime": {
- "description": "The end time of the interval.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "The start time of the interval.",
- "format": "google-datetime",
- "type": "string"
- },
- "values": {
- "description": "The measured values during this time interval. Each value must have a different dataSourceName.",
- "type": "array",
- "items": {
- "$ref": "CollectdValue"
- }
- }
- },
- "id": "CollectdPayload"
- },
- "CreateCollectdTimeSeriesResponse": {
- "description": "The CreateCollectdTimeSeries response.",
- "type": "object",
- "properties": {
- "payloadErrors": {
- "description": "Records the error status for points that were not written due to an error.Failed requests for which nothing is written will return an error response instead.",
- "type": "array",
- "items": {
- "$ref": "CollectdPayloadError"
- }
- }
- },
- "id": "CreateCollectdTimeSeriesResponse"
- },
"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": {
"numFiniteBuckets": {
"description": "Must be greater than 0.",
@@ -1200,7 +28,9 @@
"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 {}.",
@@ -1224,12 +54,12 @@
"type": "object",
"properties": {
"value": {
- "description": "The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.",
- "type": "object",
"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, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.",
+ "type": "object"
},
"name": {
"description": "The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, \"map_entry\". For custom options, it should be the fully-qualified name. For example, \"google.api.http\".",
@@ -1242,10 +72,6 @@
"description": "Nimbus InternalCheckers.",
"type": "object",
"properties": {
- "gcpZone": {
- "description": "The GCP zone the uptime check should egress from. Only respected for internal uptime checks, where internal_network is specified.",
- "type": "string"
- },
"network": {
"description": "The internal network to perform this uptime check on.",
"type": "string"
@@ -1261,11 +87,17 @@
"checkerId": {
"description": "The checker ID.",
"type": "string"
+ },
+ "gcpZone": {
+ "description": "The GCP zone the uptime check should egress from. Only respected for internal uptime checks, where internal_network is specified.",
+ "type": "string"
}
},
"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.",
@@ -1273,28 +105,9 @@
"type": "integer"
}
},
- "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"
+ "id": "TcpCheck"
},
"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.",
- "type": "object",
"properties": {
"endTime": {
"description": "Required. The end of the time interval.",
@@ -1307,7 +120,24 @@
"type": "string"
}
},
- "id": "TimeInterval"
+ "id": "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.",
+ "type": "object"
+ },
+ "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.",
@@ -1331,6 +161,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": {
+ "growthFactor": {
+ "description": "Must be greater than 1.",
+ "format": "double",
+ "type": "number"
+ },
"scale": {
"description": "Must be greater than 0.",
"format": "double",
@@ -1340,53 +175,55 @@
"description": "Must be greater than 0.",
"format": "int32",
"type": "integer"
- },
- "growthFactor": {
- "description": "Must be greater than 1.",
- "format": "double",
- "type": "number"
}
},
"id": "Exponential"
},
"Point": {
- "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."
- }
- },
- "id": "Point",
"description": "A single data point in a time series.",
- "type": "object"
- },
- "Metric": {
- "description": "A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.",
"type": "object",
"properties": {
- "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"
+ "value": {
+ "$ref": "TypedValue",
+ "description": "The value of the data point."
},
- "type": {
- "description": "An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount.",
- "type": "string"
+ "interval": {
+ "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.",
+ "$ref": "TimeInterval"
}
},
- "id": "Metric"
+ "id": "Point"
},
"Field": {
"description": "A single field of a message type.",
"type": "object",
"properties": {
+ "jsonName": {
+ "description": "The field JSON name.",
+ "type": "string"
+ },
"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",
@@ -1409,31 +246,6 @@
"TYPE_SINT64"
],
"description": "The field type.",
- "type": "string",
- "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."
- ]
- },
- "jsonName": {
- "description": "The field JSON name.",
"type": "string"
},
"options": {
@@ -1448,13 +260,7 @@
"format": "int32",
"type": "integer"
},
- "packed": {
- "description": "Whether to use alternative packed wire representation.",
- "type": "boolean"
- },
"cardinality": {
- "description": "The field cardinality.",
- "type": "string",
"enumDescriptions": [
"For fields with unknown cardinality.",
"For optional fields.",
@@ -1466,7 +272,13 @@
"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.",
@@ -1506,34 +318,23 @@
},
"id": "ListUptimeCheckConfigsResponse"
},
- "LabelDescriptor": {
- "description": "A description of a label.",
+ "Metric": {
+ "description": "A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.",
"type": "object",
"properties": {
- "key": {
- "description": "The label key.",
- "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"
},
- "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": {
+ "description": "An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount.",
"type": "string"
}
},
- "id": "LabelDescriptor"
+ "id": "Metric"
},
"ListTimeSeriesResponse": {
"description": "The ListTimeSeries response.",
@@ -1553,10 +354,47 @@
},
"id": "ListTimeSeriesResponse"
},
+ "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": {
+ "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."
+ ],
+ "enum": [
+ "STRING",
+ "BOOL",
+ "INT64"
+ ]
+ }
+ },
+ "id": "LabelDescriptor"
+ },
"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",
"properties": {
+ "displayName": {
+ "description": "A user-assigned name for this group, used only for display purposes.",
+ "type": "string"
+ },
+ "isCluster": {
+ "description": "If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.",
+ "type": "boolean"
+ },
"filter": {
"description": "The filter used to determine which monitored resources belong to this group.",
"type": "string"
@@ -1568,31 +406,14 @@
"parentName": {
"description": "The name of the group's parent, if it has one. The format is \"projects/{project_id_or_number}/groups/{group_id}\". For groups with no parent, parentName is the empty string, \"\".",
"type": "string"
- },
- "displayName": {
- "description": "A user-assigned name for this group, used only for display purposes.",
- "type": "string"
- },
- "isCluster": {
- "description": "If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.",
- "type": "boolean"
}
},
"id": "Group"
},
"Type": {
+ "description": "A protocol buffer message type.",
+ "type": "object",
"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",
@@ -1600,10 +421,6 @@
"type": "string"
}
},
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- },
"syntax": {
"enumDescriptions": [
"Syntax proto2.",
@@ -1616,19 +433,34 @@
"description": "The source syntax.",
"type": "string"
},
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "The source context."
+ },
"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"
}
},
- "id": "Type",
- "description": "A protocol buffer message type.",
- "type": "object"
+ "id": "Type"
},
"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",
"properties": {
"password": {
"description": "The password to authenticate.",
@@ -1639,12 +471,19 @@
"type": "string"
}
},
- "id": "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"
+ "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": {
+ "userLabels": {
+ "description": "Output only. A map of user-defined metadata labels.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
"systemLabels": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -1652,30 +491,21 @@
},
"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": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Output only. A map of user-defined metadata labels.",
- "type": "object"
}
},
- "id": "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"
+ "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": {
"exponentialBuckets": {
- "description": "The exponential buckets.",
- "$ref": "Exponential"
+ "$ref": "Exponential",
+ "description": "The exponential buckets."
},
"linearBuckets": {
- "description": "The linear bucket.",
- "$ref": "Linear"
+ "$ref": "Linear",
+ "description": "The linear bucket."
},
"explicitBuckets": {
"description": "The explicit buckets.",
@@ -1697,72 +527,32 @@
"type": "boolean"
},
"authInfo": {
- "$ref": "BasicAuthentication",
- "description": "The authentication information. Optional when creating an HTTP check; defaults to empty."
+ "description": "The authentication information. Optional when creating an HTTP check; defaults to empty.",
+ "$ref": "BasicAuthentication"
+ },
+ "headers": {
+ "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",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "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"
- },
- "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"
}
},
"id": "HttpCheck"
},
- "CollectdValue": {
- "description": "A single data point from a collectd-based plugin.",
+ "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": {
- "dataSourceType": {
- "enum": [
- "UNSPECIFIED_DATA_SOURCE_TYPE",
- "GAUGE",
- "COUNTER",
- "DERIVE",
- "ABSOLUTE"
- ],
- "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."
- ]
- },
- "dataSourceName": {
- "description": "The data source for the collectd value. For example there are two data sources for network measurements: \"rx\" and \"tx\".",
- "type": "string"
- },
- "value": {
- "$ref": "TypedValue",
- "description": "The measurement value."
- }
- },
- "id": "CollectdValue"
- },
- "Status": {
- "properties": {
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any 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",
@@ -1773,52 +563,59 @@
},
"type": "object"
}
- }
- },
- "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"
- },
- "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\".",
+ },
+ "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": "SourceContext",
- "description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined.",
- "type": "object"
+ "id": "Status"
},
- "MetricDescriptor": {
+ "CollectdValue": {
+ "description": "A single data point from a collectd-based plugin.",
+ "type": "object",
"properties": {
- "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",
+ "dataSourceName": {
+ "description": "The data source for the collectd value. For example there are two data sources for network measurements: \"rx\" and \"tx\".",
"type": "string"
},
- "valueType": {
- "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",
+ "value": {
+ "$ref": "TypedValue",
+ "description": "The measurement value."
+ },
+ "dataSourceType": {
"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."
+ "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": [
- "VALUE_TYPE_UNSPECIFIED",
- "BOOL",
- "INT64",
- "DOUBLE",
- "STRING",
- "DISTRIBUTION",
- "MONEY"
- ]
- },
+ "UNSPECIFIED_DATA_SOURCE_TYPE",
+ "GAUGE",
+ "COUNTER",
+ "DERIVE",
+ "ABSOLUTE"
+ ],
+ "description": "The type of measurement.",
+ "type": "string"
+ }
+ },
+ "id": "CollectdValue"
+ },
+ "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.",
@@ -1830,9 +627,7 @@
"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"
+ ]
},
"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.",
@@ -1856,10 +651,45 @@
"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."
+ ]
}
},
- "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.",
+ "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": {
@@ -1879,86 +709,6 @@
"description": "The range of the population values.",
"type": "object"
},
- "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"
- },
- "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": {
- "$ref": "ResourceGroup",
- "description": "The group resource associated with the configuration."
- },
- "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": {
- "enum": [
- "REGION_UNSPECIFIED",
- "USA",
- "EUROPE",
- "SOUTH_AMERICA",
- "ASIA_PACIFIC"
- ],
- "type": "string"
- },
- "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",
@@ -1977,29 +727,89 @@
},
"id": "ListGroupsResponse"
},
- "CreateCollectdTimeSeriesRequest": {
- "description": "The CreateCollectdTimeSeries request.",
- "type": "object",
+ "UptimeCheckConfig": {
"properties": {
- "collectdVersion": {
- "description": "The version of collectd that collected the data. Example: \"5.3.0-192.el6\".",
- "type": "string"
- },
- "resource": {
- "$ref": "MonitoredResource",
- "description": "The monitored resource associated with the time series."
- },
- "collectdPayloads": {
- "description": "The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields plugin, plugin_instance, type, and type_instance.",
+ "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": "CollectdPayload"
+ "$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"
+ },
+ "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": {
+ "$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": {
+ "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"
}
},
- "id": "CreateCollectdTimeSeriesRequest"
+ "id": "UptimeCheckConfig",
+ "description": "This message configures which resources and services to monitor for availability.",
+ "type": "object"
},
"ListGroupMembersResponse": {
+ "description": "The ListGroupMembers response.",
+ "type": "object",
"properties": {
"members": {
"description": "A set of monitored resources in the group.",
@@ -2018,50 +828,59 @@
"type": "integer"
}
},
- "id": "ListGroupMembersResponse",
- "description": "The ListGroupMembers response.",
- "type": "object"
+ "id": "ListGroupMembersResponse"
+ },
+ "CreateCollectdTimeSeriesRequest": {
+ "description": "The CreateCollectdTimeSeries request.",
+ "type": "object",
+ "properties": {
+ "resource": {
+ "description": "The monitored resource associated with the time series.",
+ "$ref": "MonitoredResource"
+ },
+ "collectdPayloads": {
+ "description": "The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields plugin, plugin_instance, type, and type_instance.",
+ "type": "array",
+ "items": {
+ "$ref": "CollectdPayload"
+ }
+ },
+ "collectdVersion": {
+ "description": "The version of collectd that collected the data. Example: \"5.3.0-192.el6\".",
+ "type": "string"
+ }
+ },
+ "id": "CreateCollectdTimeSeriesRequest"
},
"ListMonitoredResourceDescriptorsResponse": {
+ "description": "The ListMonitoredResourceDescriptors 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"
- },
"resourceDescriptors": {
"description": "The monitored resource descriptors that are available to this project and that match filter, if present.",
"type": "array",
"items": {
"$ref": "MonitoredResourceDescriptor"
}
+ },
+ "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": "ListMonitoredResourceDescriptorsResponse",
- "description": "The ListMonitoredResourceDescriptors response.",
- "type": "object"
+ "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": {
"description": "The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data.",
"$ref": "MonitoredResource"
},
"metadata": {
- "$ref": "MonitoredResourceMetadata",
- "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."
+ "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.",
+ "$ref": "MonitoredResourceMetadata"
},
"valueType": {
"enumDescriptions": [
@@ -2086,6 +905,8 @@
"type": "string"
},
"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.",
@@ -2097,9 +918,18 @@
"GAUGE",
"DELTA",
"CUMULATIVE"
- ],
- "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"
+ ]
+ },
+ "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": {
+ "description": "The associated metric. A fully-specified metric used to identify the time series.",
+ "$ref": "Metric"
}
},
"id": "TimeSeries"
@@ -2119,6 +949,8 @@
"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.",
@@ -2148,35 +980,31 @@
}
},
"bucketOptions": {
- "$ref": "BucketOptions",
- "description": "Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries."
+ "description": "Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries.",
+ "$ref": "BucketOptions"
}
},
- "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"
+ "id": "Distribution"
},
"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"
+ "id": "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"
},
"ListMetricDescriptorsResponse": {
- "description": "The ListMetricDescriptors response.",
- "type": "object",
"properties": {
"metricDescriptors": {
"description": "The metric descriptors that are available to the project and that match the value of filter, if present.",
@@ -2190,12 +1018,1184 @@
"type": "string"
}
},
- "id": "ListMetricDescriptorsResponse"
+ "id": "ListMetricDescriptorsResponse",
+ "description": "The ListMetricDescriptors response.",
+ "type": "object"
+ },
+ "CollectdPayloadError": {
+ "description": "Describes the error status for payloads that were not written.",
+ "type": "object",
+ "properties": {
+ "index": {
+ "description": "The zero-based index in CreateCollectdTimeSeriesRequest.collectd_payloads.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "Records the error status for the payload. If this field is present, the partial errors for nested values won't be populated."
+ },
+ "valueErrors": {
+ "description": "Records the error status for values that were not written due to an error.Failed payloads for which nothing is written will not include partial value errors.",
+ "type": "array",
+ "items": {
+ "$ref": "CollectdValueError"
+ }
+ }
+ },
+ "id": "CollectdPayloadError"
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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).",
+ "A group of instances from Google Cloud Platform (GCP) or Amazon Web Services (AWS).",
+ "A group of AWS load balancers."
+ ],
+ "enum": [
+ "RESOURCE_TYPE_UNSPECIFIED",
+ "INSTANCE",
+ "AWS_ELB_LOAD_BALANCER"
+ ],
+ "description": "The resource type of the group members.",
+ "type": "string"
+ }
+ },
+ "id": "ResourceGroup"
+ },
+ "TypedValue": {
+ "description": "A single strongly-typed value.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "TypedValue"
+ },
+ "UptimeCheckIp": {
+ "description": "Contains the region, location, and list of IP addresses where checkers in the location run from.",
+ "type": "object",
+ "properties": {
+ "ipAddress": {
+ "description": "The IP address from which the uptime check originates. This is a full IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely and should support interpreting this field in either IPv4 or IPv6 format.",
+ "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": [
+ "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)."
+ ]
+ },
+ "location": {
+ "description": "A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category.",
+ "type": "string"
+ }
+ },
+ "id": "UptimeCheckIp"
+ },
+ "CollectdValueError": {
+ "properties": {
+ "error": {
+ "description": "Records the error status for the value.",
+ "$ref": "Status"
+ },
+ "index": {
+ "description": "The zero-based index in CollectdPayload.values within the parent CreateCollectdTimeSeriesRequest.collectd_payloads.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "CollectdValueError",
+ "description": "Describes the error status for values that were not written.",
+ "type": "object"
+ },
+ "CollectdPayload": {
+ "description": "A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information.",
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "description": "The start time of the interval.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "values": {
+ "description": "The measured values during this time interval. Each value must have a different dataSourceName.",
+ "type": "array",
+ "items": {
+ "$ref": "CollectdValue"
+ }
+ },
+ "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",
+ "type": "string"
+ }
+ },
+ "id": "CollectdPayload"
+ },
+ "CreateCollectdTimeSeriesResponse": {
+ "properties": {
+ "payloadErrors": {
+ "description": "Records the error status for points that were not written due to an error.Failed requests for which nothing is written will return an error response instead.",
+ "type": "array",
+ "items": {
+ "$ref": "CollectdPayloadError"
+ }
+ }
+ },
+ "id": "CreateCollectdTimeSeriesResponse",
+ "description": "The CreateCollectdTimeSeries 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"
+ },
+ "protocol": "rest",
+ "canonicalName": "Monitoring",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/monitoring": {
+ "description": "View and write monitoring data for all of your Google and third-party Cloud and API projects"
+ },
+ "https://www.googleapis.com/auth/monitoring.write": {
+ "description": "Publish metric data to your Google Cloud projects"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/monitoring.read": {
+ "description": "View monitoring data for all of your Google Cloud and third-party projects"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://monitoring.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "monitoring",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Stackdriver Monitoring API",
+ "ownerName": "Google",
+ "resources": {
+ "uptimeCheckIps": {
+ "methods": {
+ "list": {
+ "flatPath": "v3/uptimeCheckIps",
+ "path": "v3/uptimeCheckIps",
+ "id": "monitoring.uptimeCheckIps.list",
+ "description": "Returns the list of IPs that checkers run from",
+ "response": {
+ "$ref": "ListUptimeCheckIpsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "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. NOTE: this field is not yet implemented",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ]
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "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",
+ "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"
+ }
+ }
+ },
+ "metricDescriptors": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "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"
+ }
+ },
+ "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": {
+ "description": "Lists metric descriptors that match a filter. This method does not require a Stackdriver account.",
+ "response": {
+ "$ref": "ListMetricDescriptorsResponse"
+ },
+ "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": {
+ "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",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors",
+ "path": "v3/{+name}/metricDescriptors",
+ "id": "monitoring.projects.metricDescriptors.list"
+ },
+ "get": {
+ "description": "Gets a single metric descriptor. This method does not require a Stackdriver account.",
+ "response": {
+ "$ref": "MetricDescriptor"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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 value of {metric_id} is \"compute.googleapis.com/instance/disk/read_bytes_count\".",
+ "required": true,
+ "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/{metricDescriptorsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.metricDescriptors.get"
+ },
+ "create": {
+ "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"
+ },
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "timeSeries": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListTimeSeriesResponse"
+ },
+ "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": {
+ "aggregation.crossSeriesReducer": {
+ "enum": [
+ "REDUCE_NONE",
+ "REDUCE_MEAN",
+ "REDUCE_MIN",
+ "REDUCE_MAX",
+ "REDUCE_SUM",
+ "REDUCE_STDDEV",
+ "REDUCE_COUNT",
+ "REDUCE_COUNT_TRUE",
+ "REDUCE_FRACTION_TRUE",
+ "REDUCE_PERCENTILE_99",
+ "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",
+ "location": "query"
+ },
+ "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"
+ },
+ "aggregation.perSeriesAligner": {
+ "location": "query",
+ "enum": [
+ "ALIGN_NONE",
+ "ALIGN_DELTA",
+ "ALIGN_RATE",
+ "ALIGN_INTERPOLATE",
+ "ALIGN_NEXT_OLDER",
+ "ALIGN_MIN",
+ "ALIGN_MAX",
+ "ALIGN_MEAN",
+ "ALIGN_COUNT",
+ "ALIGN_SUM",
+ "ALIGN_STDDEV",
+ "ALIGN_COUNT_TRUE",
+ "ALIGN_FRACTION_TRUE",
+ "ALIGN_PERCENTILE_99",
+ "ALIGN_PERCENTILE_95",
+ "ALIGN_PERCENTILE_50",
+ "ALIGN_PERCENTILE_05"
+ ],
+ "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.",
+ "type": "string"
+ },
+ "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": {
+ "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"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "FULL",
+ "HEADERS"
+ ],
+ "description": "Specifies which information is returned about the time series.",
+ "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"
+ },
+ "aggregation.groupByFields": {
+ "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,
+ "location": "query"
+ },
+ "interval.endTime": {
+ "location": "query",
+ "description": "Required. The end of the time interval.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "aggregation.alignmentPeriod": {
+ "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",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/timeSeries",
+ "path": "v3/{+name}/timeSeries",
+ "id": "monitoring.projects.timeSeries.list",
+ "description": "Lists time series that match a filter. This method does not require a Stackdriver account."
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ]
+ }
+ }
+ },
+ "uptimeCheckConfigs": {
+ "methods": {
+ "delete": {
+ "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 uptime check configuration to delete. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}",
+ "path": "v3/{+name}",
+ "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."
+ },
+ "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": {
+ "parent": {
+ "location": "path",
+ "description": "The project whose uptime check configurations are listed. The format isprojects/[PROJECT_ID].",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs",
+ "path": "v3/{+parent}/uptimeCheckConfigs",
+ "id": "monitoring.projects.uptimeCheckConfigs.list"
+ },
+ "get": {
+ "response": {
+ "$ref": "UptimeCheckConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The uptime check configuration to retrieve. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.uptimeCheckConfigs.get",
+ "description": "Gets a single uptime check configuration."
+ },
+ "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": {
+ "path": "v3/{+parent}/uptimeCheckConfigs",
+ "id": "monitoring.projects.uptimeCheckConfigs.create",
+ "request": {
+ "$ref": "UptimeCheckConfig"
+ },
+ "description": "Creates a new uptime check configuration.",
+ "response": {
+ "$ref": "UptimeCheckConfig"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "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"
+ }
+ }
+ },
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "list": {
+ "description": "Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.",
+ "response": {
+ "$ref": "ListMonitoredResourceDescriptorsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label:\nresource.type = starts_with(\"gce_\") AND resource.label:id\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}/monitoredResourceDescriptors",
+ "path": "v3/{+name}/monitoredResourceDescriptors",
+ "id": "monitoring.projects.monitoredResourceDescriptors.list"
+ },
+ "get": {
+ "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors/{monitoredResourceDescriptorsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.monitoredResourceDescriptors.get",
+ "description": "Gets a single monitored resource descriptor. This method does not require a Stackdriver account.",
+ "response": {
+ "$ref": "MonitoredResourceDescriptor"
+ },
+ "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": {
+ "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.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/monitoredResourceDescriptors/[^/]+$",
+ "location": "path"
+ }
+ }
+ }
+ }
+ },
+ "groups": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an existing group.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.groups.delete"
+ },
+ "list": {
+ "description": "Lists the existing groups.",
+ "response": {
+ "$ref": "ListGroupsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "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/[^/]+$"
+ },
+ "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"
+ }
+ },
+ "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",
+ "path": "v3/{+name}/groups",
+ "id": "monitoring.projects.groups.list"
+ },
+ "get": {
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.groups.get",
+ "description": "Gets a single group.",
+ "response": {
+ "$ref": "Group"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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"
+ ]
+ },
+ "update": {
+ "response": {
+ "$ref": "Group"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path",
+ "description": "Output only. The name of this group. The format is \"projects/{project_id_or_number}/groups/{group_id}\". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.",
+ "required": true,
+ "type": "string"
+ },
+ "validateOnly": {
+ "location": "query",
+ "description": "If true, validate this request but do not update the existing group.",
+ "type": "boolean"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.groups.update",
+ "request": {
+ "$ref": "Group"
+ },
+ "description": "Updates an existing group. You can change any group attributes except name."
+ },
+ "create": {
+ "response": {
+ "$ref": "Group"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "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"
+ },
+ "validateOnly": {
+ "location": "query",
+ "description": "If true, validate this request but do not create the group.",
+ "type": "boolean"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups",
+ "path": "v3/{+name}/groups",
+ "id": "monitoring.projects.groups.create",
+ "request": {
+ "$ref": "Group"
+ },
+ "description": "Creates a new group."
+ }
+ },
+ "resources": {
+ "members": {
+ "methods": {
+ "list": {
+ "description": "Lists the monitored resources that are members of a group.",
+ "response": {
+ "$ref": "ListGroupMembersResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32",
+ "type": "integer",
+ "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",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
+ },
+ "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": {
+ "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"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}/members",
+ "path": "v3/{+name}/members",
+ "id": "monitoring.projects.groups.members.list"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "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": "v3"
}
diff --git a/oslogin/v1/oslogin-api.json b/oslogin/v1/oslogin-api.json
index 15d9b93..e68aa4e 100644
--- a/oslogin/v1/oslogin-api.json
+++ b/oslogin/v1/oslogin-api.json
@@ -1,11 +1,373 @@
{
+ "ownerDomain": "google.com",
+ "name": "oslogin",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Cloud OS Login API",
+ "ownerName": "Google",
+ "resources": {
+ "users": {
+ "resources": {
+ "sshPublicKeys": {
+ "methods": {
+ "delete": {
+ "description": "Deletes an SSH public key.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "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": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "id": "oslogin.users.sshPublicKeys.delete",
+ "path": "v1/{+name}"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "flatPath": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "path": "v1/{+name}",
+ "id": "oslogin.users.sshPublicKeys.get"
+ },
+ "patch": {
+ "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": {
+ "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": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "id": "oslogin.users.sshPublicKeys.patch",
+ "path": "v1/{+name}",
+ "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": "v1/users/{usersId}/projects/{projectsId}",
+ "path": "v1/{+name}",
+ "id": "oslogin.users.projects.delete",
+ "description": "Deletes a POSIX account."
+ }
+ }
+ }
+ },
+ "methods": {
+ "importSshPublicKey": {
+ "id": "oslogin.users.importSshPublicKey",
+ "path": "v1/{+parent}: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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ImportSshPublicKeyResponse"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "The project ID of the Google Cloud Platform project.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^users/[^/]+$",
+ "location": "path",
+ "description": "The unique ID for the user in format `users/{user}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "v1/users/{usersId}:importSshPublicKey"
+ },
+ "getLoginProfile": {
+ "response": {
+ "$ref": "LoginProfile"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The unique ID for the user in format `users/{user}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^users/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/users/{usersId}/loginProfile",
+ "path": "v1/{+name}/loginProfile",
+ "id": "oslogin.users.getLoginProfile",
+ "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine."
+ }
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://oslogin.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Manages OS login configuration for Google account users.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "oslogin:v1",
+ "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
+ "revision": "20171211",
"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"
+ },
+ "posixAccounts": {
+ "description": "The list of POSIX accounts associated with the user.",
+ "type": "array",
+ "items": {
+ "$ref": "PosixAccount"
+ }
+ },
+ "suspended": {
+ "description": "Indicates if the user is suspended. A suspended user cannot log in but\ntheir profile information is retained.",
+ "type": "boolean"
+ }
+ },
+ "id": "LoginProfile"
+ },
+ "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"
+ },
+ "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",
+ "type": "string"
+ },
+ "fingerprint": {
+ "description": "Output only. The SHA-256 fingerprint of the SSH public key.",
+ "type": "string"
+ }
+ },
+ "id": "SshPublicKey"
+ },
+ "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."
+ }
+ },
+ "id": "ImportSshPublicKeyResponse"
+ },
"PosixAccount": {
"description": "The POSIX account information associated with a Google account.",
"type": "object",
"properties": {
+ "primary": {
+ "description": "Only one POSIX account can be marked as primary.",
+ "type": "boolean"
+ },
"accountId": {
"description": "Output only. A POSIX account identifier.",
"type": "string"
@@ -39,390 +401,28 @@
"gecos": {
"description": "The GECOS (user information) entry for this account.",
"type": "string"
- },
- "primary": {
- "description": "Only one POSIX account can be marked as primary.",
- "type": "boolean"
}
},
"id": "PosixAccount"
- },
- "LoginProfile": {
- "id": "LoginProfile",
- "description": "The user profile information used for logging in to a virtual machine on\nGoogle Compute Engine.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The primary email address that uniquely identifies the user.",
- "type": "string"
- },
- "posixAccounts": {
- "description": "The list of POSIX accounts associated with the user.",
- "type": "array",
- "items": {
- "$ref": "PosixAccount"
- }
- },
- "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"
- }
- }
- },
- "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"
- },
- "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",
- "type": "string"
- },
- "fingerprint": {
- "description": "Output only. The SHA-256 fingerprint of the SSH public key.",
- "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"
}
},
"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": {
"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/compute": {
+ "description": "View and manage your Google Compute Engine resources"
}
}
}
},
- "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": {
- "getLoginProfile": {
- "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine.",
- "response": {
- "$ref": "LoginProfile"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "name": {
- "description": "The unique ID for the user in format `users/{user}`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/users/{usersId}/loginProfile",
- "path": "v1/{+name}/loginProfile",
- "id": "oslogin.users.getLoginProfile"
- },
- "importSshPublicKey": {
- "id": "oslogin.users.importSshPublicKey",
- "path": "v1/{+parent}: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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ImportSshPublicKeyResponse"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "flatPath": "v1/users/{usersId}:importSshPublicKey"
- }
- },
- "resources": {
- "sshPublicKeys": {
- "methods": {
- "delete": {
- "id": "oslogin.users.sshPublicKeys.delete",
- "path": "v1/{+name}",
- "description": "Deletes an SSH public key.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}"
- },
- "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": {
- "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": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "path": "v1/{+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": {
- "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"
- },
- "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": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "id": "oslogin.users.sshPublicKeys.patch",
- "path": "v1/{+name}"
- }
- }
- },
- "projects": {
- "methods": {
- "delete": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "parameters": {
- "name": {
- "pattern": "^users/[^/]+/projects/[^/]+$",
- "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"
- }
- },
- "flatPath": "v1/users/{usersId}/projects/{projectsId}",
- "path": "v1/{+name}",
- "id": "oslogin.users.projects.delete",
- "description": "Deletes a POSIX account.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE"
- }
- }
- }
- }
- }
- },
- "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": {
- "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": {
- "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://oslogin.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Manages OS login configuration for Google account users.",
- "servicePath": "",
- "basePath": "",
- "id": "oslogin:v1",
- "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
- "revision": "20171211"
+ "rootUrl": "https://oslogin.googleapis.com/"
}
diff --git a/oslogin/v1alpha/oslogin-api.json b/oslogin/v1alpha/oslogin-api.json
index 135904a..09fb940 100644
--- a/oslogin/v1alpha/oslogin-api.json
+++ b/oslogin/v1alpha/oslogin-api.json
@@ -1,32 +1,309 @@
{
+ "ownerName": "Google",
+ "resources": {
+ "users": {
+ "resources": {
+ "sshPublicKeys": {
+ "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": {
+ "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": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "path": "v1alpha/{+name}",
+ "id": "oslogin.users.sshPublicKeys.delete",
+ "description": "Deletes an SSH public key."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "SshPublicKey"
+ },
+ "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": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
+ "id": "oslogin.users.sshPublicKeys.get",
+ "path": "v1alpha/{+name}",
+ "description": "Retrieves an SSH public key."
+ },
+ "patch": {
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "SshPublicKey"
+ },
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "Mask to control which fields get updated. Updates all if not present.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "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}",
+ "id": "oslogin.users.sshPublicKeys.patch",
+ "path": "v1alpha/{+name}",
+ "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": {
+ "pattern": "^users/[^/]+/projects/[^/]+$",
+ "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"
+ }
+ },
+ "flatPath": "v1alpha/users/{usersId}/projects/{projectsId}",
+ "path": "v1alpha/{+name}",
+ "id": "oslogin.users.projects.delete",
+ "description": "Deletes a POSIX account."
+ }
+ }
+ }
+ },
+ "methods": {
+ "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.",
+ "response": {
+ "$ref": "ImportSshPublicKeyResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
+ "flatPath": "v1alpha/users/{usersId}:importSshPublicKey"
+ },
+ "getLoginProfile": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "LoginProfile"
+ },
+ "parameters": {
+ "name": {
+ "description": "The unique ID for the user in format `users/{user}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^users/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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"
+ ],
+ "flatPath": "v1alpha/users/{usersId}/loginProfile",
+ "id": "oslogin.users.getLoginProfile",
+ "path": "v1alpha/{+name}/loginProfile",
+ "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine."
+ }
+ }
+ }
+ },
+ "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\").",
+ "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": {
+ "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": {
+ "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": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ }
+ },
"version": "v1alpha",
"baseUrl": "https://oslogin.googleapis.com/",
"servicePath": "",
"description": "Manages OS login configuration for Google account users.",
"kind": "discovery#restDescription",
"basePath": "",
- "id": "oslogin:v1alpha",
- "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
"revision": "20171211",
+ "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
+ "id": "oslogin:v1alpha",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "PosixAccount": {
- "description": "The POSIX account information associated with a Google account.",
+ "ImportSshPublicKeyResponse": {
+ "description": "A response message for importing an SSH public key.",
"type": "object",
"properties": {
- "homeDirectory": {
- "description": "The path to the home directory for this account.",
- "type": "string"
- },
- "gecos": {
- "description": "The GECOS (user information) entry for this account.",
- "type": "string"
- },
- "systemId": {
- "description": "System identifier for which account the username or uid applies to.\nBy default, the empty value is used.",
- "type": "string"
- },
+ "loginProfile": {
+ "$ref": "LoginProfile",
+ "description": "The login profile information for the user."
+ }
+ },
+ "id": "ImportSshPublicKeyResponse"
+ },
+ "PosixAccount": {
+ "properties": {
"primary": {
"description": "Only one POSIX account can be marked as primary.",
"type": "boolean"
@@ -52,14 +329,35 @@
"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"
+ },
+ "gecos": {
+ "description": "The GECOS (user information) entry for this account.",
+ "type": "string"
+ },
+ "systemId": {
+ "description": "System identifier for which account the username or uid applies to.\nBy default, the empty value is used.",
+ "type": "string"
}
},
- "id": "PosixAccount"
+ "id": "PosixAccount",
+ "description": "The POSIX account information associated with a Google account.",
+ "type": "object"
},
"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": "A unique user ID for identifying the user.",
"type": "string"
@@ -74,13 +372,6 @@
"suspended": {
"description": "Indicates if the user is suspended.",
"type": "boolean"
- },
- "sshPublicKeys": {
- "additionalProperties": {
- "$ref": "SshPublicKey"
- },
- "description": "A map from SSH public key fingerprint to the associated key object.",
- "type": "object"
}
},
"id": "LoginProfile"
@@ -95,6 +386,10 @@
"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",
@@ -103,31 +398,16 @@
"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": {
@@ -152,285 +432,5 @@
"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": {
- "projectId": {
- "description": "The project ID of the Google Cloud Platform project.",
- "type": "string",
- "location": "query"
- },
- "parent": {
- "location": "path",
- "description": "The unique ID for the user in format `users/{user}`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+$"
- }
- },
- "flatPath": "v1alpha/users/{usersId}:importSshPublicKey",
- "path": "v1alpha/{+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": {
- "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine.",
- "response": {
- "$ref": "LoginProfile"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The unique ID for the user in format `users/{user}`.",
- "required": true,
- "type": "string",
- "pattern": "^users/[^/]+$"
- }
- },
- "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"
- ],
- "flatPath": "v1alpha/users/{usersId}/loginProfile",
- "path": "v1alpha/{+name}/loginProfile",
- "id": "oslogin.users.getLoginProfile"
- }
- },
- "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": {
- "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/[^/]+$"
- }
- },
- "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "path": "v1alpha/{+name}",
- "id": "oslogin.users.sshPublicKeys.delete"
- },
- "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": {
- "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": {
- "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.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.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ],
- "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/[^/]+$"
- }
- },
- "flatPath": "v1alpha/users/{usersId}/projects/{projectsId}",
- "path": "v1alpha/{+name}",
- "id": "oslogin.users.projects.delete"
- }
- }
- }
- }
- }
- },
- "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": {
- "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": {
- "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"
- }
- }
+ "title": "Google Cloud OS Login API"
}
diff --git a/oslogin/v1beta/oslogin-api.json b/oslogin/v1beta/oslogin-api.json
index bd9bde0..412404a 100644
--- a/oslogin/v1beta/oslogin-api.json
+++ b/oslogin/v1beta/oslogin-api.json
@@ -1,45 +1,15 @@
{
+ "discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "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": {}
- },
- "SshPublicKey": {
- "description": "The SSH public key information associated with a Google account.",
- "type": "object",
- "properties": {
- "expirationTimeUsec": {
- "description": "An expiration time in microseconds since epoch.",
- "format": "int64",
- "type": "string"
- },
- "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"
- },
"PosixAccount": {
+ "description": "The POSIX account information associated with a Google account.",
+ "type": "object",
"properties": {
+ "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"
@@ -73,15 +43,9 @@
"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",
- "description": "The POSIX account information associated with a Google account.",
- "type": "object"
+ "id": "PosixAccount"
},
"LoginProfile": {
"description": "The user profile information used for logging in to a virtual machine on\nGoogle Compute Engine.",
@@ -103,21 +67,58 @@
"type": "boolean"
},
"sshPublicKeys": {
+ "description": "A map from SSH public key fingerprint to the associated key object.",
+ "type": "object",
"additionalProperties": {
"$ref": "SshPublicKey"
- },
- "description": "A map from SSH public key fingerprint to the associated key object.",
- "type": "object"
+ }
}
},
"id": "LoginProfile"
+ },
+ "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"
+ },
+ "SshPublicKey": {
+ "description": "The SSH public key information associated with a Google account.",
+ "type": "object",
+ "properties": {
+ "expirationTimeUsec": {
+ "description": "An expiration time in microseconds since epoch.",
+ "format": "int64",
+ "type": "string"
+ },
+ "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": {
+ "$ref": "LoginProfile",
+ "description": "The login profile information for the user."
+ }
+ },
+ "id": "ImportSshPublicKeyResponse"
}
},
- "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": {
@@ -148,17 +149,17 @@
"users": {
"methods": {
"importSshPublicKey": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
+ "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"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "parameterOrder": [
+ "parent"
],
+ "httpMethod": "POST",
"parameters": {
"projectId": {
"location": "query",
@@ -166,22 +167,23 @@
"type": "string"
},
"parent": {
+ "location": "path",
"description": "The unique ID for the user in format `users/{user}`.",
"required": true,
"type": "string",
- "pattern": "^users/[^/]+$",
- "location": "path"
+ "pattern": "^users/[^/]+$"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ],
"flatPath": "v1beta/users/{usersId}:importSshPublicKey",
- "id": "oslogin.users.importSshPublicKey",
"path": "v1beta/{+parent}: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"
- }
+ "id": "oslogin.users.importSshPublicKey"
},
"getLoginProfile": {
+ "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine.",
"response": {
"$ref": "LoginProfile"
},
@@ -191,11 +193,11 @@
"httpMethod": "GET",
"parameters": {
"name": {
- "pattern": "^users/[^/]+$",
- "location": "path",
"description": "The unique ID for the user in format `users/{user}`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^users/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -206,24 +208,59 @@
],
"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."
+ "id": "oslogin.users.getLoginProfile"
}
},
"resources": {
"sshPublicKeys": {
"methods": {
- "delete": {
- "httpMethod": "DELETE",
+ "get": {
+ "description": "Retrieves an SSH public key.",
+ "response": {
+ "$ref": "SshPublicKey"
+ },
"parameterOrder": [
"name"
],
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "GET",
"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/[^/]+$"
+ }
+ },
+ "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"
+ },
+ "patch": {
+ "request": {
+ "$ref": "SshPublicKey"
+ },
+ "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics.",
+ "response": {
+ "$ref": "SshPublicKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "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",
@@ -235,75 +272,9 @@
"https://www.googleapis.com/auth/compute"
],
"flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "id": "oslogin.users.sshPublicKeys.delete",
"path": "v1beta/{+name}",
- "description": "Deletes an SSH public key."
+ "id": "oslogin.users.sshPublicKeys.patch"
},
- "get": {
- "response": {
- "$ref": "SshPublicKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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}",
- "path": "v1beta/{+name}",
- "id": "oslogin.users.sshPublicKeys.get",
- "description": "Retrieves an SSH public key."
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "SshPublicKey"
- },
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "Mask to control which fields get updated. Updates all if not present.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "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": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "id": "oslogin.users.sshPublicKeys.patch",
- "path": "v1beta/{+name}",
- "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"
@@ -318,17 +289,47 @@
],
"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",
+ "description": "Deletes an SSH public key."
+ }
+ }
+ },
+ "projects": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a POSIX account.",
+ "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",
- "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}`."
+ "location": "path"
}
},
"flatPath": "v1beta/users/{usersId}/projects/{projectsId}",
"path": "v1beta/{+name}",
- "id": "oslogin.users.projects.delete",
- "description": "Deletes a POSIX account."
+ "id": "oslogin.users.projects.delete"
}
}
}
@@ -336,21 +337,75 @@
}
},
"parameters": {
- "quotaUser": {
+ "uploadType": {
"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": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "pp": {
+ "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": {
+ "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": {
+ "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"
+ "default": "true",
+ "location": "query"
},
"oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
+ "location": "query"
},
"bearer_token": {
"location": "query",
@@ -363,74 +418,19 @@
"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",
+ "default": "true",
"location": "query"
- },
- "$.xgafv": {
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
- },
- "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": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
}
},
"version": "v1beta",
"baseUrl": "https://oslogin.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Manages OS login configuration for Google account users.",
"servicePath": "",
+ "description": "Manages OS login configuration for Google account users.",
+ "kind": "discovery#restDescription",
"basePath": "",
"id": "oslogin:v1beta",
"documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/",
- "revision": "20171211",
- "discoveryVersion": "v1"
+ "revision": "20171211"
}
diff --git a/partners/v2/partners-api.json b/partners/v2/partners-api.json
index c6b010a..bb972aa 100644
--- a/partners/v2/partners-api.json
+++ b/partners/v2/partners-api.json
@@ -1,4 +1,12 @@
{
+ "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": "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": "",
@@ -15,103 +23,39 @@
"ownerName": "Google",
"version_module": true,
"resources": {
- "exams": {
- "methods": {
- "getToken": {
- "id": "partners.exams.getToken",
- "path": "v2/exams/{examType}/token",
- "description": "Gets an Exam Token for a Partner's user to take an exam in the Exams System",
- "httpMethod": "GET",
- "parameterOrder": [
- "examType"
- ],
- "response": {
- "$ref": "ExamToken"
- },
- "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.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": {
- "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"
- },
- "examType": {
- "location": "path",
- "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 exam type we are requesting a token for.",
- "required": true,
- "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"
- }
- },
- "flatPath": "v2/exams/{examType}/token"
- }
- }
- },
"leads": {
"methods": {
"list": {
+ "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.",
"response": {
"$ref": "ListLeadsResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
- "orderBy": {
- "description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported",
+ "requestMetadata.experimentIds": {
"type": "string",
- "location": "query"
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to."
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported"
},
"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"
+ "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."
},
"requestMetadata.partnersSessionId": {
+ "location": "query",
"description": "Google Partners session ID.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"requestMetadata.userOverrides.userId": {
"location": "query",
@@ -130,9 +74,9 @@
"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",
- "location": "query"
+ "type": "string"
},
"requestMetadata.locale": {
"location": "query",
@@ -140,91 +84,96 @@
"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": {
- "repeated": true,
"location": "query",
- "description": "Experiment IDs the current request belongs to.",
+ "description": "IP address to use instead of the user's geo-located IP address.",
"type": "string"
}
- },
- "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": {
+ "response": {
+ "$ref": "ListOffersResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
"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",
- "location": "query"
+ "type": "string"
},
"requestMetadata.locale": {
- "description": "Locale to use for the current request.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Locale to use for the current request."
},
"requestMetadata.userOverrides.ipAddress": {
+ "type": "string",
"location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
+ "description": "IP address to use instead of the user's geo-located IP address."
},
"requestMetadata.experimentIds": {
+ "location": "query",
"description": "Experiment IDs the current request belongs to.",
"type": "string",
- "repeated": true,
- "location": "query"
+ "repeated": true
},
"requestMetadata.trafficSource.trafficSubId": {
+ "type": "string",
"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"
+ "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."
},
"requestMetadata.userOverrides.userId": {
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID."
},
"requestMetadata.partnersSessionId": {
+ "location": "query",
"description": "Google Partners session ID.",
- "type": "string",
- "location": "query"
+ "type": "string"
}
},
"flatPath": "v2/offers",
"path": "v2/offers",
"id": "partners.offers.list",
- "description": "Lists the Offers available for the current user",
- "response": {
- "$ref": "ListOffersResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET"
+ "description": "Lists the Offers available for the current user"
}
},
"resources": {
"history": {
"methods": {
"list": {
+ "response": {
+ "$ref": "ListOffersHistoryResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
- "pageToken": {
+ "requestMetadata.userOverrides.userId": {
+ "type": "string",
"location": "query",
- "description": "Token to retrieve a specific page.",
+ "description": "Logged-in user ID to impersonate instead of the user's ID."
+ },
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
"type": "string"
},
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Token to retrieve a specific page."
+ },
"pageSize": {
- "description": "Maximum number of rows to return per page.",
- "format": "int32",
"type": "integer",
- "location": "query"
+ "location": "query",
+ "description": "Maximum number of rows to return per page.",
+ "format": "int32"
},
"requestMetadata.trafficSource.trafficSourceId": {
"location": "query",
@@ -232,25 +181,25 @@
"type": "string"
},
"requestMetadata.locale": {
+ "type": "string",
"location": "query",
- "description": "Locale to use for the current request.",
- "type": "string"
+ "description": "Locale to use for the current request."
},
"requestMetadata.userOverrides.ipAddress": {
+ "type": "string",
"location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
+ "description": "IP address to use instead of the user's geo-located IP address."
},
"requestMetadata.experimentIds": {
+ "type": "string",
"repeated": true,
"location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string"
+ "description": "Experiment IDs the current request belongs to."
},
"entireCompany": {
+ "location": "query",
"description": "if true, show history for the entire company. Requires user to be admin.",
- "type": "boolean",
- "location": "query"
+ "type": "boolean"
},
"requestMetadata.trafficSource.trafficSubId": {
"location": "query",
@@ -258,30 +207,15 @@
"type": "string"
},
"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"
- },
- "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"
+ "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."
}
},
"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"
+ "description": "Lists the Historical Offers for the current user (or user's entire company)"
}
}
}
@@ -290,28 +224,37 @@
"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.",
"response": {
"$ref": "ListAnalyticsResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
- "requestMetadata.userOverrides.ipAddress": {
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "type": "string",
"location": "query",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string"
+ "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.locale": {
+ "type": "string",
+ "location": "query",
+ "description": "Locale to use for the current request."
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "type": "string",
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address."
},
"requestMetadata.experimentIds": {
+ "type": "string",
"repeated": true,
"location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string"
+ "description": "Experiment IDs the current request belongs to."
},
"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"
+ "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."
},
"requestMetadata.userOverrides.userId": {
"location": "query",
@@ -319,210 +262,144 @@
"type": "string"
},
"requestMetadata.partnersSessionId": {
+ "location": "query",
"description": "Google Partners session ID.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageToken": {
+ "type": "string",
"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"
+ "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."
},
"pageSize": {
"location": "query",
"description": "Requested page size. Server may return fewer analytics than requested.\nIf unspecified or set to 0, default value is 30.\nSpecifies the number of days in the date range when querying analytics.\nThe `page_token` represents the end date of the date range\nand the start date is calculated using the `page_size` as the number\nof days BEFORE the end date.\nMust be a non-negative integer.",
"format": "int32",
"type": "integer"
- },
- "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"
}
},
"flatPath": "v2/analytics",
"path": "v2/analytics",
- "id": "partners.analytics.list"
+ "id": "partners.analytics.list",
+ "description": "Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in user."
}
}
},
"userStates": {
"methods": {
"list": {
- "description": "Lists states for current user.",
"httpMethod": "GET",
"response": {
"$ref": "ListUserStatesResponse"
},
"parameterOrder": [],
"parameters": {
- "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": {
- "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": {
+ "type": "string",
"repeated": true,
"location": "query",
- "description": "Experiment IDs the current request belongs to.",
+ "description": "Experiment IDs the current request belongs to."
+ },
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID."
+ },
+ "requestMetadata.partnersSessionId": {
+ "type": "string",
+ "location": "query",
+ "description": "Google Partners session ID."
+ },
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "Locale to use for the current request."
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address.",
"type": "string"
}
},
"flatPath": "v2/userStates",
"id": "partners.userStates.list",
- "path": "v2/userStates"
+ "path": "v2/userStates",
+ "description": "Lists states for current user."
}
}
},
"v2": {
"methods": {
- "updateLeads": {
- "response": {
- "$ref": "Lead"
- },
- "parameterOrder": [],
+ "updateCompanies": {
"httpMethod": "PATCH",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Company"
+ },
"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": {
+ "type": "string",
+ "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."
+ },
+ "requestMetadata.locale": {
+ "type": "string",
+ "location": "query",
+ "description": "Locale to use for the current request."
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "type": "string",
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address."
+ },
+ "updateMask": {
+ "type": "string",
+ "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"
+ },
+ "requestMetadata.experimentIds": {
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to."
+ },
"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": {
- "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": {
- "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": {
- "location": "query",
- "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"
- },
- "requestMetadata.experimentIds": {
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string"
}
},
- "flatPath": "v2/leads",
- "path": "v2/leads",
- "id": "partners.updateLeads",
- "description": "Updates the specified lead.",
- "request": {
- "$ref": "Lead"
- }
- },
- "updateCompanies": {
+ "flatPath": "v2/companies",
"id": "partners.updateCompanies",
"path": "v2/companies",
"request": {
"$ref": "Company"
},
- "description": "Update company.\nShould only be called within the context of an authorized logged in user.",
- "httpMethod": "PATCH",
- "parameterOrder": [],
- "response": {
- "$ref": "Company"
- },
- "parameters": {
- "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": {
- "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"
- },
- "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"
- }
- },
- "flatPath": "v2/companies"
+ "description": "Update company.\nShould only be called within the context of an authorized logged in user."
},
"getPartnersstatus": {
+ "flatPath": "v2/partnersstatus",
"id": "partners.getPartnersstatus",
"path": "v2/partnersstatus",
"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.",
@@ -538,9 +415,9 @@
"type": "string"
},
"requestMetadata.partnersSessionId": {
+ "location": "query",
"description": "Google Partners session ID.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"requestMetadata.trafficSource.trafficSourceId": {
"location": "query",
@@ -548,102 +425,91 @@
"type": "string"
},
"requestMetadata.locale": {
+ "type": "string",
"location": "query",
- "description": "Locale to use for the current request.",
- "type": "string"
+ "description": "Locale to use for the current request."
},
"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": {
- "description": "Experiment IDs the current request belongs to.",
"type": "string",
"repeated": true,
- "location": "query"
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to."
},
"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"
}
+ }
+ },
+ "updateLeads": {
+ "description": "Updates the specified lead.",
+ "request": {
+ "$ref": "Lead"
},
- "flatPath": "v2/partnersstatus"
- }
- }
- },
- "companies": {
- "methods": {
- "get": {
+ "response": {
+ "$ref": "Lead"
+ },
+ "parameterOrder": [],
+ "httpMethod": "PATCH",
"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.locale": {
+ "type": "string",
+ "location": "query",
+ "description": "Locale to use for the current request."
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "type": "string",
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address."
+ },
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "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"
+ },
+ "requestMetadata.experimentIds": {
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to."
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "type": "string",
+ "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."
+ },
"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"
- },
- "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": {
- "description": "Locale to use for the current request.",
- "type": "string",
- "location": "query"
- },
- "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"
- },
- "companyId": {
- "location": "path",
- "description": "The ID of the company to retrieve.",
- "required": true,
- "type": "string"
- },
- "requestMetadata.experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "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.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": {
- "location": "query",
- "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"
+ "description": "Google Partners session ID."
}
},
+ "flatPath": "v2/leads",
+ "path": "v2/leads",
+ "id": "partners.updateLeads"
+ }
+ }
+ },
+ "companies": {
+ "methods": {
+ "get": {
"flatPath": "v2/companies/{companyId}",
"id": "partners.companies.get",
"path": "v2/companies/{companyId}",
@@ -654,9 +520,80 @@
],
"response": {
"$ref": "GetCompanyResponse"
+ },
+ "parameters": {
+ "requestMetadata.experimentIds": {
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to."
+ },
+ "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.trafficSource.trafficSubId": {
+ "type": "string",
+ "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."
+ },
+ "orderBy": {
+ "type": "string",
+ "location": "query",
+ "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."
+ },
+ "requestMetadata.userOverrides.userId": {
+ "type": "string",
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID."
+ },
+ "requestMetadata.partnersSessionId": {
+ "type": "string",
+ "location": "query",
+ "description": "Google Partners session ID."
+ },
+ "view": {
+ "type": "string",
+ "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`."
+ },
+ "requestMetadata.locale": {
+ "type": "string",
+ "location": "query",
+ "description": "Locale to use for the current request."
+ },
+ "address": {
+ "type": "string",
+ "location": "query",
+ "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."
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "type": "string",
+ "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."
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
+ },
+ "companyId": {
+ "location": "path",
+ "description": "The ID of the company to retrieve.",
+ "required": true,
+ "type": "string"
+ }
}
},
"list": {
+ "flatPath": "v2/companies",
+ "path": "v2/companies",
+ "id": "partners.companies.list",
"description": "Lists companies.",
"response": {
"$ref": "ListCompaniesResponse"
@@ -664,36 +601,18 @@
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
- "languageCodes": {
- "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,
- "location": "query"
- },
- "pageSize": {
- "description": "Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default.",
- "format": "int32",
- "type": "integer",
- "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": {
- "repeated": true,
"location": "query",
"description": "Experiment IDs the current request belongs to.",
- "type": "string"
+ "type": "string",
+ "repeated": true
},
"orderBy": {
- "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",
- "location": "query"
+ "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."
},
"specializations": {
- "repeated": true,
"location": "query",
"enum": [
"BADGE_SPECIALIZATION_UNKNOWN",
@@ -704,17 +623,18 @@
"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"
+ "type": "string",
+ "repeated": true
},
"maxMonthlyBudget.currencyCode": {
+ "type": "string",
"location": "query",
- "description": "The 3-letter currency code defined in ISO 4217.",
- "type": "string"
+ "description": "The 3-letter currency code defined in ISO 4217."
},
"requestMetadata.userOverrides.userId": {
+ "location": "query",
"description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"minMonthlyBudget.currencyCode": {
"location": "query",
@@ -722,23 +642,23 @@
"type": "string"
},
"view": {
+ "type": "string",
"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"
+ "description": "The view of the `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`."
},
"requestMetadata.locale": {
+ "type": "string",
"location": "query",
- "description": "Locale to use for the current request.",
- "type": "string"
+ "description": "Locale to use for the current request."
},
"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",
- "location": "query"
+ "type": "string"
},
"minMonthlyBudget.units": {
"location": "query",
@@ -747,15 +667,12 @@
"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",
- "location": "query"
+ "type": "integer"
},
"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,
"location": "query",
"enum": [
"SERVICE_UNSPECIFIED",
@@ -765,12 +682,15 @@
"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": {
+ "type": "string",
"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"
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
},
"maxMonthlyBudget.units": {
"location": "query",
@@ -779,10 +699,10 @@
"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",
- "location": "query"
+ "type": "integer"
},
"requestMetadata.trafficSource.trafficSubId": {
"location": "query",
@@ -790,22 +710,21 @@
"type": "string"
},
"requestMetadata.partnersSessionId": {
+ "location": "query",
"description": "Google Partners session ID.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"companyName": {
+ "type": "string",
"location": "query",
- "description": "Company name to search for.",
- "type": "string"
+ "description": "Company name to search for."
},
"pageToken": {
+ "type": "string",
"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"
+ "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."
},
"industries": {
- "description": "List of industries the company can help with.",
"type": "string",
"repeated": true,
"location": "query",
@@ -821,15 +740,15 @@
"I_RETAIL",
"I_TECHNOLOGY",
"I_TRAVEL"
- ]
+ ],
+ "description": "List of industries the company can help with."
},
"websiteUrl": {
+ "type": "string",
"location": "query",
- "description": "Website URL that will help to find a better matched company.\n.",
- "type": "string"
+ "description": "Website URL that will help to find a better matched company.\n."
},
"gpsMotivations": {
- "description": "List of reasons for using Google Partner Search to get companies.",
"type": "string",
"repeated": true,
"location": "query",
@@ -838,18 +757,40 @@
"GPSM_HELP_WITH_ADVERTISING",
"GPSM_HELP_WITH_WEBSITE",
"GPSM_NO_WEBSITE"
- ]
+ ],
+ "description": "List of reasons for using Google Partner Search to get companies."
+ },
+ "languageCodes": {
+ "type": "string",
+ "repeated": true,
+ "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\")."
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default.",
+ "format": "int32"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "type": "string",
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address."
}
- },
- "flatPath": "v2/companies",
- "path": "v2/companies",
- "id": "partners.companies.list"
+ }
}
},
"resources": {
"leads": {
"methods": {
"create": {
+ "response": {
+ "$ref": "CreateLeadResponse"
+ },
+ "parameterOrder": [
+ "companyId"
+ ],
+ "httpMethod": "POST",
"parameters": {
"companyId": {
"location": "path",
@@ -864,14 +805,7 @@
"request": {
"$ref": "CreateLeadRequest"
},
- "description": "Creates an advertiser lead for the given company ID.",
- "response": {
- "$ref": "CreateLeadResponse"
- },
- "parameterOrder": [
- "companyId"
- ],
- "httpMethod": "POST"
+ "description": "Creates an advertiser lead for the given company ID."
}
}
}
@@ -879,29 +813,39 @@
},
"users": {
"methods": {
- "createCompanyRelation": {
+ "get": {
"response": {
- "$ref": "CompanyRelation"
+ "$ref": "User"
},
"parameterOrder": [
"userId"
],
- "httpMethod": "PUT",
+ "httpMethod": "GET",
"parameters": {
+ "requestMetadata.partnersSessionId": {
+ "type": "string",
+ "location": "query",
+ "description": "Google Partners session ID."
+ },
"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.",
+ "userView": {
"type": "string",
- "location": "query"
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "PROFILE",
+ "PUBLIC_PROFILE"
+ ],
+ "description": "Specifies what parts of the user information to return."
},
"requestMetadata.trafficSource.trafficSourceId": {
+ "type": "string",
"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"
+ "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.locale": {
"location": "query",
@@ -914,21 +858,130 @@
"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": {
+ "type": "string",
+ "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."
},
"userId": {
"location": "path",
- "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.",
+ "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",
+ "description": "Gets a user."
+ },
+ "updateProfile": {
+ "response": {
+ "$ref": "UserProfile"
+ },
+ "parameterOrder": [],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "type": "string",
+ "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."
+ },
+ "requestMetadata.locale": {
+ "type": "string",
+ "location": "query",
+ "description": "Locale to use for the current request."
+ },
+ "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"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "requestMetadata.partnersSessionId": {
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Google Partners session ID."
+ }
+ },
+ "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."
+ },
+ "createCompanyRelation": {
+ "response": {
+ "$ref": "CompanyRelation"
+ },
+ "parameterOrder": [
+ "userId"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "requestMetadata.userOverrides.userId": {
+ "type": "string",
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID."
+ },
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "Locale to use for the current request."
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "type": "string",
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address."
+ },
+ "requestMetadata.experimentIds": {
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true
+ },
+ "userId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user."
+ },
+ "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/users/{userId}/companyRelation",
@@ -940,53 +993,6 @@
"description": "Creates a user's company relation. Affiliates the user to a company."
},
"deleteCompanyRelation": {
- "parameters": {
- "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": {
- "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": {
- "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.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": {
- "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"
- }
- },
- "flatPath": "v2/users/{userId}/companyRelation",
- "path": "v2/users/{userId}/companyRelation",
- "id": "partners.users.deleteCompanyRelation",
"description": "Deletes a user's company relation. Unaffiliaites the user from a company.",
"response": {
"$ref": "Empty"
@@ -994,136 +1000,60 @@
"parameterOrder": [
"userId"
],
- "httpMethod": "DELETE"
- },
- "get": {
- "path": "v2/users/{userId}",
- "id": "partners.users.get",
- "description": "Gets a user.",
- "response": {
- "$ref": "User"
- },
- "parameterOrder": [
- "userId"
- ],
- "httpMethod": "GET",
+ "httpMethod": "DELETE",
"parameters": {
- "requestMetadata.userOverrides.ipAddress": {
- "description": "IP address to use instead of the user's geo-located IP address.",
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's 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": {
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Locale to use for the current request."
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
},
"requestMetadata.experimentIds": {
- "repeated": true,
"location": "query",
"description": "Experiment IDs the current request belongs to.",
- "type": "string"
+ "type": "string",
+ "repeated": true
},
"requestMetadata.trafficSource.trafficSubId": {
+ "type": "string",
"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"
+ "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."
},
"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"
- },
- "requestMetadata.partnersSessionId": {
- "location": "query",
- "description": "Google Partners session ID.",
- "type": "string"
- },
- "requestMetadata.userOverrides.userId": {
- "location": "query",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "type": "string"
- },
- "userView": {
- "description": "Specifies what parts of the user information to return.",
"type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "PROFILE",
- "PUBLIC_PROFILE"
- ]
- },
- "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"
+ "location": "path",
+ "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user."
}
},
- "flatPath": "v2/users/{userId}"
- },
- "updateProfile": {
- "parameters": {
- "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": {
- "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": {
- "description": "IP address to use instead of the user's geo-located IP address.",
- "type": "string",
- "location": "query"
- },
- "requestMetadata.experimentIds": {
- "repeated": true,
- "location": "query",
- "description": "Experiment IDs the current request belongs to.",
- "type": "string"
- }
- },
- "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"
+ "flatPath": "v2/users/{userId}/companyRelation",
+ "path": "v2/users/{userId}/companyRelation",
+ "id": "partners.users.deleteCompanyRelation"
}
}
},
"userEvents": {
"methods": {
"log": {
- "description": "Logs a user event.",
- "request": {
- "$ref": "LogUserEventRequest"
- },
"httpMethod": "POST",
"parameterOrder": [],
"response": {
@@ -1132,17 +1062,17 @@
"parameters": {},
"flatPath": "v2/userEvents:log",
"id": "partners.userEvents.log",
- "path": "v2/userEvents:log"
+ "path": "v2/userEvents:log",
+ "description": "Logs a user event.",
+ "request": {
+ "$ref": "LogUserEventRequest"
+ }
}
}
},
"clientMessages": {
"methods": {
"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"
},
@@ -1151,22 +1081,121 @@
"parameters": {},
"flatPath": "v2/clientMessages:log",
"path": "v2/clientMessages:log",
- "id": "partners.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."
+ }
+ }
+ },
+ "exams": {
+ "methods": {
+ "getToken": {
+ "description": "Gets an Exam Token for a Partner's user to take an exam in the Exams System",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "examType"
+ ],
+ "response": {
+ "$ref": "ExamToken"
+ },
+ "parameters": {
+ "examType": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "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 exam type we are requesting a token for."
+ },
+ "requestMetadata.userOverrides.userId": {
+ "type": "string",
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID."
+ },
+ "requestMetadata.partnersSessionId": {
+ "type": "string",
+ "location": "query",
+ "description": "Google Partners session ID."
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "type": "string",
+ "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."
+ },
+ "requestMetadata.locale": {
+ "location": "query",
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "type": "string",
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address."
+ },
+ "requestMetadata.experimentIds": {
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to."
+ },
+ "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/exams/{examType}/token",
+ "id": "partners.exams.getToken",
+ "path": "v2/exams/{examType}/token"
}
}
}
},
"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": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Pretty-print response."
+ },
+ "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"
+ },
"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",
+ "description": "Returns response with indentations and line breaks."
},
"uploadType": {
"location": "query",
@@ -1174,17 +1203,16 @@
"type": "string"
},
"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."
},
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"$.xgafv": {
- "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
@@ -1194,9 +1222,16 @@
"enum": [
"1",
"2"
- ]
+ ],
+ "description": "V1 error format."
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -1204,380 +1239,62 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
+ "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"
+ "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": {
+ "type": "string",
"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": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "description": "OAuth access token."
}
},
"schemas": {
- "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"
- },
- "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": {
- "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info.",
- "$ref": "RecaptchaChallenge"
- }
- },
- "id": "CreateLeadRequest"
- },
- "RequestMetadata": {
- "description": "Common data that is in each API request.",
- "type": "object",
- "properties": {
- "experimentIds": {
- "description": "Experiment IDs the current request belongs to.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "trafficSource": {
- "$ref": "TrafficSource",
- "description": "Source of traffic for the current request."
- },
- "locale": {
- "description": "Locale to use for the current request.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "RequestMetadata"
- },
- "EventData": {
- "id": "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"
- }
- }
- }
- },
- "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": {
- "description": "The type of the exam.",
- "type": "string",
- "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"
- ]
- },
- "taken": {
- "description": "The date the user last taken this exam.",
- "format": "google-datetime",
- "type": "string"
- },
- "passed": {
- "description": "Whether this exam has been passed and not expired.",
- "type": "boolean"
- }
- },
- "id": "ExamStatus"
- },
- "ListOffersResponse": {
- "id": "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": {
- "description": "Reason why no Offers are available.",
- "type": "string",
- "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"
- ]
- }
- }
- },
- "CountryOfferInfo": {
- "description": "Offer info by country.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- }
- },
- "id": "CountryOfferInfo"
- },
"ListCompaniesResponse": {
- "id": "ListCompaniesResponse",
"description": "Response message for\nListCompanies.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "type": "string",
+ "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."
+ },
"responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
},
"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"
+ },
+ "description": "The list of companies."
}
- }
+ },
+ "id": "ListCompaniesResponse"
},
"OfferCustomer": {
- "id": "OfferCustomer",
- "description": "Customers qualified for an offer.",
"type": "object",
"properties": {
+ "spendXAmount": {
+ "type": "string",
+ "description": "Formatted Spend X amount with currency code."
+ },
+ "adwordsUrl": {
+ "description": "URL to the customer's AdWords page.",
+ "type": "string"
+ },
"eligibilityDaysLeft": {
"description": "Days the customer is still eligible.",
"format": "int32",
"type": "integer"
},
"creationTime": {
+ "type": "string",
"description": "Time the customer was created.",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
},
"countryCode": {
"description": "Country code of the customer.",
@@ -1589,12 +1306,6 @@
"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",
@@ -1602,7 +1313,13 @@
"OFFER_TYPE_SPEND_MATCH"
],
"description": "Type of the offer",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ]
},
"getYAmount": {
"description": "Formatted Get Y amount with currency code.",
@@ -1611,19 +1328,12 @@
"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",
+ "description": "Customers qualified for an offer."
},
"CertificationStatus": {
- "id": "CertificationStatus",
"description": "Google Partners certification status.",
"type": "object",
"properties": {
@@ -1635,7 +1345,6 @@
}
},
"type": {
- "description": "The type of the certification.",
"type": "string",
"enumDescriptions": [
"Unchosen.",
@@ -1664,68 +1373,78 @@
"CT_ADWORDS_SEARCH",
"CT_ADWORDS_DISPLAY",
"CT_MOBILE_SITES"
- ]
+ ],
+ "description": "The type of the certification."
},
"userCount": {
+ "type": "integer",
"description": "Number of people who are certified,",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"isCertified": {
- "description": "Whether certification is passing.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether certification is passing."
}
- }
+ },
+ "id": "CertificationStatus"
},
"LocalizedCompanyInfo": {
- "id": "LocalizedCompanyInfo",
- "description": "The localized company information.",
"type": "object",
"properties": {
+ "countryCodes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "List of country codes for the localized company info."
+ },
"overview": {
"description": "Localized brief description that the company uses to advertise themselves.",
"type": "string"
},
"displayName": {
- "description": "Localized display name.",
- "type": "string"
+ "type": "string",
+ "description": "Localized display name."
},
"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"
- }
}
- }
+ },
+ "id": "LocalizedCompanyInfo",
+ "description": "The localized company information."
},
"LogUserEventResponse": {
- "description": "Response message for\nLogUserEvent.",
"type": "object",
"properties": {
"responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
}
},
- "id": "LogUserEventResponse"
+ "id": "LogUserEventResponse",
+ "description": "Response message for\nLogUserEvent."
},
"ListOffersHistoryResponse": {
"description": "Response for ListOfferHistory.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "Supply this token in a ListOffersHistoryRequest to retrieve the next page."
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
"canShowEntireCompany": {
- "description": "True if the user has the option to show entire company history.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "True if the user has the option to show entire company history."
},
"totalResults": {
+ "type": "integer",
"description": "Number of results across all pages.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"showingEntireCompany": {
"description": "True if this response is showing entire company history.",
@@ -1737,20 +1456,11 @@
"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"
}
},
"id": "ListOffersHistoryResponse"
},
"LogMessageResponse": {
- "description": "Response message for\nLogClientMessage.",
"type": "object",
"properties": {
"responseMetadata": {
@@ -1758,21 +1468,14 @@
"description": "Current response metadata."
}
},
- "id": "LogMessageResponse"
+ "id": "LogMessageResponse",
+ "description": "Response message for\nLogClientMessage."
},
"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",
@@ -1782,15 +1485,17 @@
"BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
],
"description": "The specialization this status is for.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown specialization",
+ "AdWords Search specialization",
+ "AdWords Display specialization",
+ "AdWords Mobile specialization",
+ "AdWords Video specialization",
+ "AdWords Shopping specialization"
+ ]
},
"badgeSpecializationState": {
- "enumDescriptions": [
- "Unknown state",
- "Specialization passed",
- "Specialization not passed",
- "Specialization in grace"
- ],
"enum": [
"BADGE_SPECIALIZATION_STATE_UNKNOWN",
"BADGE_SPECIALIZATION_STATE_PASSED",
@@ -1798,34 +1503,22 @@
"BADGE_SPECIALIZATION_STATE_IN_GRACE"
],
"description": "State of agency specialization.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown state",
+ "Specialization passed",
+ "Specialization not passed",
+ "Specialization in grace"
+ ]
}
},
"id": "SpecializationStatus"
},
"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"
- },
- "expiration": {
- "description": "Date this certification is due to expire.",
- "format": "google-datetime",
- "type": "string"
- },
- "warning": {
- "description": "Whether this certification is in the state of warning.",
- "type": "boolean"
- },
"certificationType": {
+ "type": "string",
"enumDescriptions": [
"Unchosen.",
"AdWords certified.",
@@ -1854,42 +1547,55 @@
"CT_ADWORDS_DISPLAY",
"CT_MOBILE_SITES"
],
- "description": "The type of certification, the area of expertise.",
+ "description": "The type of certification, the area of expertise."
+ },
+ "lastAchieved": {
+ "type": "string",
+ "description": "The date the user last achieved certification.",
+ "format": "google-datetime"
+ },
+ "achieved": {
+ "type": "boolean",
+ "description": "Whether this certification has been achieved."
+ },
+ "expiration": {
+ "description": "Date this certification is due to expire.",
+ "format": "google-datetime",
"type": "string"
+ },
+ "warning": {
+ "description": "Whether this certification is in the state of warning.",
+ "type": "boolean"
}
},
- "id": "Certification"
+ "id": "Certification",
+ "description": "A user's information on a specific certification."
},
"User": {
- "description": "A resource representing a user of the Partners platform.",
"type": "object",
"properties": {
- "id": {
- "description": "The ID of the user.",
- "type": "string"
- },
"publicProfile": {
- "description": "Information about a user's external public profile outside Google Partners.",
- "$ref": "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"
- }
+ },
+ "description": "The list of achieved certifications. These are calculated based on exam\nresults and other requirements.\n@OutputOnly"
},
"companyVerificationEmail": {
- "description": "The email address used by the user used for company verification.\n@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "The email address used by the user used for company verification.\n@OutputOnly"
},
"company": {
"$ref": "CompanyRelation",
"description": "The company that the user is associated with.\nIf not present, the user is not associated with any company."
},
"profile": {
- "description": "The profile information of a Partners user, contains all the directly\neditable user information.",
- "$ref": "UserProfile"
+ "$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",
@@ -1897,63 +1603,122 @@
"type": "string"
},
"primaryEmails": {
- "description": "The list of emails the user has access to/can select as primary.\n@OutputOnly",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "The list of emails the user has access to/can select as primary.\n@OutputOnly"
},
"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",
"items": {
"$ref": "AdWordsManagerAccountInfo"
- }
+ },
+ "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"
},
"internalId": {
- "description": "The internal user ID.\nOnly available for a whitelisted set of api clients.",
- "type": "string"
+ "type": "string",
+ "description": "The internal user ID.\nOnly available for a whitelisted set of api clients."
},
"examStatus": {
- "description": "The list of exams the user ever taken. For each type of exam, only one\nentry is listed.",
"type": "array",
"items": {
"$ref": "ExamStatus"
- }
+ },
+ "description": "The list of exams the user ever taken. For each type of exam, only one\nentry is listed."
+ },
+ "id": {
+ "description": "The ID of the user.",
+ "type": "string"
}
},
- "id": "User"
+ "id": "User",
+ "description": "A resource representing a user of the Partners platform."
},
"ListAnalyticsResponse": {
"description": "Response message for\nListAnalytics.",
"type": "object",
"properties": {
- "responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
- },
- "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"
- }
- },
"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": {
+ "$ref": "AnalyticsSummary",
+ "description": "Aggregated information across the response's\nanalytics."
+ },
+ "analytics": {
+ "type": "array",
+ "items": {
+ "$ref": "Analytics"
+ },
+ "description": "The list of analytics.\nSorted in ascending order of\nAnalytics.event_date."
}
},
"id": "ListAnalyticsResponse"
},
"Company": {
- "description": "A company resource in the Google Partners API. Once certified, it qualifies\nfor being searched by advertisers.",
"type": "object",
"properties": {
+ "localizedInfos": {
+ "type": "array",
+ "items": {
+ "$ref": "LocalizedCompanyInfo"
+ },
+ "description": "The list of localized info for the company."
+ },
+ "certificationStatuses": {
+ "type": "array",
+ "items": {
+ "$ref": "CertificationStatus"
+ },
+ "description": "The list of Google Partners certification statuses for the company."
+ },
+ "id": {
+ "description": "The ID of the company.",
+ "type": "string"
+ },
+ "publicProfile": {
+ "$ref": "PublicProfile",
+ "description": "Basic information from the company's public profile."
+ },
+ "originalMinMonthlyBudget": {
+ "$ref": "Money",
+ "description": "The unconverted minimum monthly budget that the company accepts for partner\nbusiness."
+ },
+ "services": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "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"
+ ]
+ },
+ "enumDescriptions": [
+ "Unchosen.",
+ "Help with advanced AdWords support.",
+ "Help with advertising on Google.",
+ "Help with an enhanced website.",
+ "Help with an online marketing plan.",
+ "Help with mobile and video ads.",
+ "Help with mobile websites."
+ ],
+ "description": "Services the company can help with."
+ },
+ "primaryLocation": {
+ "$ref": "Location",
+ "description": "The primary location of the company."
+ },
"ranks": {
"description": "Information related to the ranking of the company within the list of\ncompanies.",
"type": "array",
@@ -1962,41 +1727,27 @@
}
},
"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": "Partner badge tier",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Tier badge is not set.",
+ "Agency has regular partner badge.",
+ "Agency has premier badge."
+ ]
},
"specializationStatus": {
- "description": "The list of Google Partners specialization statuses for the company.",
"type": "array",
"items": {
"$ref": "SpecializationStatus"
- }
+ },
+ "description": "The list of Google Partners specialization statuses for the company."
},
"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": {
"type": "string",
@@ -2013,7 +1764,21 @@
"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."
+ ],
+ "description": "Company type labels listed on the company's profile."
},
"autoApprovalEmailDomains": {
"description": "Email domains that allow users with a matching email address to get\nauto-approved for associating with this company.",
@@ -2023,7 +1788,6 @@
}
},
"profileStatus": {
- "description": "The public viewability status of the company's profile.",
"type": "string",
"enumDescriptions": [
"Unchosen.",
@@ -2036,7 +1800,8 @@
"HIDDEN",
"PUBLISHED",
"SEARCHABLE"
- ]
+ ],
+ "description": "The public viewability status of the company's profile."
},
"primaryLanguageCode": {
"description": "The primary language code of the company, 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\").",
@@ -2054,22 +1819,10 @@
"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": {
+ "type": "string",
"enum": [
"INDUSTRY_UNSPECIFIED",
"I_AUTOMOTIVE",
@@ -2082,9 +1835,21 @@
"I_RETAIL",
"I_TECHNOLOGY",
"I_TRAVEL"
- ],
- "type": "string"
- }
+ ]
+ },
+ "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."
+ ]
},
"additionalWebsites": {
"description": "URL of the company's additional websites used to verify the dynamic badges.\nThese are stored as full URLs as entered by the user, but only the TLD will\nbe used for the actual verification.",
@@ -2105,91 +1870,37 @@
"name": {
"description": "The name of the company.",
"type": "string"
- },
- "localizedInfos": {
- "description": "The list of localized info for the company.",
- "type": "array",
- "items": {
- "$ref": "LocalizedCompanyInfo"
- }
- },
- "certificationStatuses": {
- "description": "The list of Google Partners certification statuses for the company.",
- "type": "array",
- "items": {
- "$ref": "CertificationStatus"
- }
- },
- "id": {
- "description": "The ID of the company.",
- "type": "string"
- },
- "publicProfile": {
- "$ref": "PublicProfile",
- "description": "Basic information from the company's public profile."
- },
- "originalMinMonthlyBudget": {
- "description": "The unconverted minimum monthly budget that the company accepts for partner\nbusiness.",
- "$ref": "Money"
- },
- "services": {
- "enumDescriptions": [
- "Unchosen.",
- "Help with advanced AdWords support.",
- "Help with advertising on Google.",
- "Help with an enhanced website.",
- "Help with an online marketing plan.",
- "Help with mobile and video ads.",
- "Help with mobile websites."
- ],
- "description": "Services the company can help with.",
- "type": "array",
- "items": {
- "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"
- ],
- "type": "string"
- }
- },
- "primaryLocation": {
- "$ref": "Location",
- "description": "The primary location of the company."
}
},
- "id": "Company"
+ "id": "Company",
+ "description": "A company resource in the Google Partners API. Once certified, it qualifies\nfor being searched by advertisers."
},
"ListLeadsResponse": {
- "id": "ListLeadsResponse",
- "description": "Response message for ListLeads.",
"type": "object",
"properties": {
"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"
+ "type": "string",
+ "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."
},
"responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
},
"totalSize": {
+ "type": "integer",
"description": "The total count of leads for the given company.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"leads": {
- "description": "The list of leads.",
"type": "array",
"items": {
"$ref": "Lead"
- }
+ },
+ "description": "The list of leads."
}
- }
+ },
+ "id": "ListLeadsResponse",
+ "description": "Response message for ListLeads."
},
"CreateLeadResponse": {
"description": "Response message for CreateLead.",
@@ -2200,7 +1911,6 @@
"description": "Lead that was created depending on the outcome of\n\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e validation."
},
"recaptchaStatus": {
- "description": "The outcome of \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e\nvalidation.",
"type": "string",
"enumDescriptions": [
"Unchosen.",
@@ -2213,7 +1923,8 @@
"RS_NOT_NEEDED",
"RS_PASSED",
"RS_FAILED"
- ]
+ ],
+ "description": "The outcome of \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e\nvalidation."
},
"responseMetadata": {
"$ref": "ResponseMetadata",
@@ -2223,36 +1934,35 @@
"id": "CreateLeadResponse"
},
"GetCompanyResponse": {
- "description": "Response message for GetCompany.",
"type": "object",
"properties": {
"company": {
- "description": "The company.",
- "$ref": "Company"
+ "$ref": "Company",
+ "description": "The company."
},
"responseMetadata": {
- "description": "Current response metadata.",
- "$ref": "ResponseMetadata"
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
}
},
- "id": "GetCompanyResponse"
+ "id": "GetCompanyResponse",
+ "description": "Response message for GetCompany."
},
"Location": {
- "id": "Location",
"description": "A location with address and geographic coordinates. May optionally contain a\ndetailed (multi-field) version of the address.",
"type": "object",
"properties": {
"administrativeArea": {
- "description": "Top-level administrative subdivision of this country.",
- "type": "string"
+ "type": "string",
+ "description": "Top-level administrative subdivision of this country."
},
"locality": {
- "description": "Generally refers to the city/town portion of an address.",
- "type": "string"
+ "type": "string",
+ "description": "Generally refers to the city/town portion of an address."
},
"latLng": {
- "description": "The latitude and longitude of the location, in degrees.",
- "$ref": "LatLng"
+ "$ref": "LatLng",
+ "description": "The latitude and longitude of the location, in degrees."
},
"regionCode": {
"description": "CLDR (Common Locale Data Repository) region code .",
@@ -2263,41 +1973,36 @@
"type": "string"
},
"address": {
- "description": "The single string version of the address.",
- "type": "string"
+ "type": "string",
+ "description": "The single string version of the address."
},
"postalCode": {
"description": "Values are frequently alphanumeric.",
"type": "string"
},
"sortingCode": {
- "description": "Use of this code is very country-specific, but will refer to a secondary\nclassification code for sorting mail.",
- "type": "string"
+ "type": "string",
+ "description": "Use of this code is very country-specific, but will refer to a secondary\nclassification code for sorting mail."
},
"languageCode": {
"description": "Language code of the address. Should be in BCP 47 format.",
"type": "string"
},
"addressLine": {
- "description": "The following address lines represent the most specific part of any\naddress.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "The following address lines represent the most specific part of any\naddress."
}
- }
+ },
+ "id": "Location"
},
"CertificationExamStatus": {
"description": "Status for a Google Partners certification exam.",
"type": "object",
"properties": {
- "numberUsersPass": {
- "description": "The number of people who have passed the certification exam.",
- "format": "int32",
- "type": "integer"
- },
"type": {
- "description": "The type of certification exam.",
"type": "string",
"enumDescriptions": [
"Unchosen.",
@@ -2324,26 +2029,23 @@
"CET_MOBILE",
"CET_DIGITAL_SALES",
"CET_MOBILE_SITES"
- ]
+ ],
+ "description": "The type of certification exam."
+ },
+ "numberUsersPass": {
+ "description": "The number of people who have passed the certification exam.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "CertificationExamStatus"
},
"ExamToken": {
- "id": "ExamToken",
"description": "A token that allows a user to take an exam.",
"type": "object",
"properties": {
- "examId": {
- "description": "The id of the exam the token is for.",
- "format": "int64",
- "type": "string"
- },
- "token": {
- "description": "The token, only present if the user has access to the exam.",
- "type": "string"
- },
"examType": {
+ "type": "string",
"enumDescriptions": [
"Unchosen.",
"Adwords Fundamentals exam.",
@@ -2370,19 +2072,35 @@
"CET_DIGITAL_SALES",
"CET_MOBILE_SITES"
],
- "description": "The type of the exam the token belongs to.",
+ "description": "The type of the exam the token belongs to."
+ },
+ "examId": {
+ "type": "string",
+ "description": "The id of the exam the token is for.",
+ "format": "int64"
+ },
+ "token": {
+ "description": "The token, only present if the user has access to the exam.",
"type": "string"
}
- }
+ },
+ "id": "ExamToken"
},
"OptIns": {
- "description": "A set of opt-ins for a user.",
"type": "object",
"properties": {
- "physicalMail": {
- "description": "An opt-in to receive special promotional gifts and material in the mail.",
+ "specialOffers": {
+ "description": "An opt-in about receiving email regarding new features and products.",
"type": "boolean"
},
+ "performanceSuggestions": {
+ "description": "An opt-in about receiving email with customized AdWords campaign management\ntips.",
+ "type": "boolean"
+ },
+ "physicalMail": {
+ "type": "boolean",
+ "description": "An opt-in to receive special promotional gifts and material in the mail."
+ },
"phoneContact": {
"description": "An opt-in to allow recieivng phone calls about their Partners account.",
"type": "boolean"
@@ -2390,50 +2108,78 @@
"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"
- },
- "performanceSuggestions": {
- "description": "An opt-in about receiving email with customized AdWords campaign management\ntips.",
- "type": "boolean"
}
},
- "id": "OptIns"
+ "id": "OptIns",
+ "description": "A set of opt-ins for a user."
},
"Rank": {
- "description": "Information related to ranking of results.",
"type": "object",
"properties": {
- "value": {
- "description": "The numerical value of the rank.",
- "format": "double",
- "type": "number"
- },
"type": {
+ "enum": [
+ "RANK_TYPE_UNSPECIFIED",
+ "RT_FINAL_SCORE"
+ ],
"description": "The type of rank.",
"type": "string",
"enumDescriptions": [
"Unchosen.",
"Total final score."
- ],
- "enum": [
- "RANK_TYPE_UNSPECIFIED",
- "RT_FINAL_SCORE"
]
+ },
+ "value": {
+ "description": "The numerical value of the rank.",
+ "format": "double",
+ "type": "number"
}
},
- "id": "Rank"
+ "id": "Rank",
+ "description": "Information related to ranking of results."
},
"UserProfile": {
- "id": "UserProfile",
- "description": "The profile information of a Partners user.",
"type": "object",
"properties": {
+ "emailAddress": {
+ "type": "string",
+ "description": "The email address the user has selected on the Partners site as primary."
+ },
+ "channels": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of ids representing which channels the user selected they were in."
+ },
+ "profilePublic": {
+ "type": "boolean",
+ "description": "Whether the user's public profile is visible to anyone with the URL."
+ },
+ "jobFunctions": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of ids represnting which job categories the user selected."
+ },
+ "givenName": {
+ "description": "The user's given name.",
+ "type": "string"
+ },
+ "address": {
+ "$ref": "Location",
+ "description": "The user's mailing address, contains multiple fields."
+ },
+ "industries": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "A list of ids representing which industries the user selected."
+ },
"emailOptIns": {
- "description": "The list of opt-ins for the user, related to communication preferences.",
- "$ref": "OptIns"
+ "$ref": "OptIns",
+ "description": "The list of opt-ins for the user, related to communication preferences."
},
"familyName": {
"description": "The user's family name.",
@@ -2447,19 +2193,19 @@
}
},
"markets": {
- "description": "A list of ids representing which markets the user was interested in.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "A list of ids representing which markets the user was interested in."
},
"migrateToAfa": {
"description": "Whether or not to migrate the user's exam data to Academy for Ads.",
"type": "boolean"
},
"phoneNumber": {
- "description": "The user's phone number.",
- "type": "string"
+ "type": "string",
+ "description": "The user's phone number."
},
"adwordsManagerAccount": {
"description": "If the user has edit access to multiple accounts, the user can choose the\npreferred account and it is used when a personal account is needed. Can\nbe empty.",
@@ -2467,50 +2213,14 @@
"type": "string"
},
"primaryCountryCode": {
- "description": "The user's primary country, an ISO 2-character code.",
- "type": "string"
- },
- "emailAddress": {
- "description": "The email address the user has selected on the Partners site as primary.",
- "type": "string"
- },
- "channels": {
- "description": "A list of ids representing which channels the user selected they were in.",
- "type": "array",
- "items": {
- "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"
- }
+ "type": "string",
+ "description": "The user's primary country, an ISO 2-character code."
}
- }
+ },
+ "id": "UserProfile",
+ "description": "The profile information of a Partners user."
},
"GetPartnersStatusResponse": {
- "id": "GetPartnersStatusResponse",
"description": "Response message for\nGetPartnersStatus.",
"type": "object",
"properties": {
@@ -2518,20 +2228,21 @@
"$ref": "ResponseMetadata",
"description": "Current response metadata."
}
- }
+ },
+ "id": "GetPartnersStatusResponse"
},
"HistoricalOffer": {
"description": "Historical information about a Google Partners Offer.",
"type": "object",
"properties": {
"clientId": {
+ "type": "string",
"description": "ID of client.",
- "format": "int64",
- "type": "string"
+ "format": "int64"
},
"clientName": {
- "description": "Name of the client.",
- "type": "string"
+ "type": "string",
+ "description": "Name of the client."
},
"lastModifiedTime": {
"description": "Time last action was taken.",
@@ -2543,7 +2254,6 @@
"type": "string"
},
"offerType": {
- "description": "Type of offer.",
"type": "string",
"enumDescriptions": [
"Unset.",
@@ -2556,11 +2266,12 @@
"OFFER_TYPE_SPEND_X_GET_Y",
"OFFER_TYPE_VIDEO",
"OFFER_TYPE_SPEND_MATCH"
- ]
+ ],
+ "description": "Type of offer."
},
"senderName": {
- "description": "Name (First + Last) of the partners user to whom the incentive is allocated.",
- "type": "string"
+ "type": "string",
+ "description": "Name (First + Last) of the partners user to whom the incentive is allocated."
},
"offerCountryCode": {
"description": "Country Code for the offer country.",
@@ -2576,12 +2287,11 @@
"type": "string"
},
"creationTime": {
+ "type": "string",
"description": "Time offer was first created.",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
},
"status": {
- "description": "Status of the offer.",
"type": "string",
"enumDescriptions": [
"Unset.",
@@ -2596,11 +2306,12 @@
"OFFER_STATUS_REDEEMED",
"OFFER_STATUS_AWARDED",
"OFFER_STATUS_EXPIRED"
- ]
+ ],
+ "description": "Status of the offer."
},
"clientEmail": {
- "description": "Email address for client.",
- "type": "string"
+ "type": "string",
+ "description": "Email address for client."
}
},
"id": "HistoricalOffer"
@@ -2609,8 +2320,30 @@
"description": "Request message for\nLogUserEvent.",
"type": "object",
"properties": {
+ "eventDatas": {
+ "description": "List of event data for the event.",
+ "type": "array",
+ "items": {
+ "$ref": "EventData"
+ }
+ },
+ "eventScope": {
+ "enum": [
+ "EVENT_SCOPE_UNSPECIFIED",
+ "VISITOR",
+ "SESSION",
+ "PAGE"
+ ],
+ "description": "The scope of the event.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Based on visitor.",
+ "Based on session.",
+ "Based on page visit."
+ ]
+ },
"eventCategory": {
- "description": "The category the action belongs to.",
"type": "string",
"enumDescriptions": [
"Unchosen.",
@@ -2647,13 +2380,15 @@
"GOOGLE_PARTNER_PORTAL_COMPANY_PROFILE",
"EXTERNAL_LINKS",
"GOOGLE_PARTNER_LANDING"
- ]
+ ],
+ "description": "The category the action belongs to."
},
"lead": {
"$ref": "Lead",
"description": "Advertiser lead information."
},
"eventAction": {
+ "type": "string",
"enumDescriptions": [
"Unchosen.",
"Advertiser clicked `Find a partner` bottom button.",
@@ -2976,124 +2711,108 @@
"AGENCY_SELECTED_OPT_IN_AFA_MIGRATION",
"AGENCY_SELECTED_OPT_OUT_AFA_MIGRATION"
],
- "description": "The action that occurred.",
- "type": "string"
+ "description": "The action that occurred."
},
"url": {
- "description": "The URL where the event occurred.",
- "type": "string"
+ "type": "string",
+ "description": "The URL where the event occurred."
},
"requestMetadata": {
"$ref": "RequestMetadata",
"description": "Current request metadata."
- },
- "eventDatas": {
- "description": "List of event data for the event.",
- "type": "array",
- "items": {
- "$ref": "EventData"
- }
- },
- "eventScope": {
- "description": "The scope of the event.",
- "type": "string",
- "enumDescriptions": [
- "Unchosen.",
- "Based on visitor.",
- "Based on session.",
- "Based on page visit."
- ],
- "enum": [
- "EVENT_SCOPE_UNSPECIFIED",
- "VISITOR",
- "SESSION",
- "PAGE"
- ]
}
},
"id": "LogUserEventRequest"
},
"UserOverrides": {
- "description": "Values to use instead of the user's respective defaults. These are only\nhonored by whitelisted products.",
"type": "object",
"properties": {
- "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"
+ },
+ "ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
}
},
- "id": "UserOverrides"
+ "id": "UserOverrides",
+ "description": "Values to use instead of the user's respective defaults. These are only\nhonored by whitelisted products."
},
"AnalyticsDataPoint": {
- "description": "Details of the analytics events for a `Company` within a single day.",
"type": "object",
"properties": {
- "eventCount": {
- "description": "Number of times the type of event occurred.\nMeaning depends on context (e.g. profile views, contacts, etc.).",
- "format": "int32",
- "type": "integer"
- },
"eventLocations": {
- "description": "Location information of where these events occurred.",
"type": "array",
"items": {
"$ref": "LatLng"
- }
+ },
+ "description": "Location information of where these events occurred."
+ },
+ "eventCount": {
+ "type": "integer",
+ "description": "Number of times the type of event occurred.\nMeaning depends on context (e.g. profile views, contacts, etc.).",
+ "format": "int32"
}
},
- "id": "AnalyticsDataPoint"
+ "id": "AnalyticsDataPoint",
+ "description": "Details of the analytics events for a `Company` within a single day."
},
"Analytics": {
"description": "Analytics data for a `Company` within a single day.",
"type": "object",
"properties": {
- "contacts": {
- "$ref": "AnalyticsDataPoint",
- "description": "Instances of users contacting the `Company`\non the specified date."
- },
"eventDate": {
- "description": "Date on which these events occurred.",
- "$ref": "Date"
+ "$ref": "Date",
+ "description": "Date on which these events occurred."
},
"profileViews": {
"$ref": "AnalyticsDataPoint",
"description": "Instances of users viewing the `Company` profile\non the specified date."
},
"searchViews": {
- "description": "Instances of users seeing the `Company` in Google Partners Search results\non the specified date.",
- "$ref": "AnalyticsDataPoint"
+ "$ref": "AnalyticsDataPoint",
+ "description": "Instances of users seeing the `Company` in Google Partners Search results\non the specified date."
+ },
+ "contacts": {
+ "$ref": "AnalyticsDataPoint",
+ "description": "Instances of users contacting the `Company`\non the specified date."
}
},
"id": "Analytics"
},
"AdWordsManagerAccountInfo": {
- "id": "AdWordsManagerAccountInfo",
- "description": "Information about a particular AdWords Manager Account.\nRead more at https://support.google.com/adwords/answer/6139186",
"type": "object",
"properties": {
- "id": {
- "description": "The AdWords Manager Account id.",
- "format": "int64",
- "type": "string"
- },
"customerName": {
"description": "Name of the customer this account represents.",
"type": "string"
+ },
+ "id": {
+ "type": "string",
+ "description": "The AdWords Manager Account id.",
+ "format": "int64"
}
- }
+ },
+ "id": "AdWordsManagerAccountInfo",
+ "description": "Information about a particular AdWords Manager Account.\nRead more at https://support.google.com/adwords/answer/6139186"
},
"PublicProfile": {
"description": "Basic information from a public profile.",
"type": "object",
"properties": {
- "profileImage": {
- "description": "The URL to the main profile image of the public profile.",
+ "id": {
+ "type": "string",
+ "description": "The ID which can be used to retrieve more details about the public profile."
+ },
+ "url": {
+ "description": "The URL of the public profile.",
"type": "string"
},
+ "profileImage": {
+ "type": "string",
+ "description": "The URL to the main profile image of the public profile."
+ },
"displayName": {
"description": "The display name of the public profile.",
"type": "string"
@@ -3101,74 +2820,41 @@
"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"
- },
- "url": {
- "description": "The URL of the public profile.",
- "type": "string"
}
},
"id": "PublicProfile"
},
"ResponseMetadata": {
- "description": "Common data that is in each API response.",
"type": "object",
"properties": {
"debugInfo": {
- "description": "Debug information about this request.",
- "$ref": "DebugInfo"
+ "$ref": "DebugInfo",
+ "description": "Debug information about this request."
}
},
- "id": "ResponseMetadata"
+ "id": "ResponseMetadata",
+ "description": "Common data that is in each API response."
},
"RecaptchaChallenge": {
- "id": "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": {
+ "type": "string",
+ "description": "The ID of the reCaptcha challenge."
}
- }
+ },
+ "id": "RecaptchaChallenge"
},
"AvailableOffer": {
"description": "Available Offers to be distributed.",
"type": "object",
"properties": {
- "qualifiedCustomer": {
- "description": "Customers who qualify for this offer.",
- "type": "array",
- "items": {
- "$ref": "OfferCustomer"
- }
- },
- "terms": {
- "description": "Terms of the offer.",
- "type": "string"
- },
- "showSpecialOfferCopy": {
- "description": "Should special text be shown on the offers page.",
- "type": "boolean"
- },
- "available": {
- "description": "The number of codes for this offer that are available for distribution.",
- "format": "int32",
- "type": "integer"
- },
- "description": {
- "description": "Description of the offer.",
- "type": "string"
- },
"offerLevel": {
- "description": "Level of this offer.",
"type": "string",
"enumDescriptions": [
"Unset.",
@@ -3189,20 +2875,21 @@
"OFFER_LEVEL_LIMIT_5",
"OFFER_LEVEL_LIMIT_15",
"OFFER_LEVEL_LIMIT_50"
- ]
+ ],
+ "description": "Level of this offer."
},
"name": {
"description": "Name of the offer.",
"type": "string"
},
"id": {
+ "type": "string",
"description": "ID of this offer.",
- "format": "int64",
- "type": "string"
+ "format": "int64"
},
"qualifiedCustomersComplete": {
- "description": "Whether or not the list of qualified customers is definitely complete.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether or not the list of qualified customers is definitely complete."
},
"countryOfferInfos": {
"description": "Offer info by country.",
@@ -3212,12 +2899,6 @@
}
},
"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",
@@ -3225,18 +2906,47 @@
"OFFER_TYPE_SPEND_MATCH"
],
"description": "Type of offer.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ]
},
"maxAccountAge": {
+ "type": "integer",
"description": "The maximum age of an account [in days] to be eligible.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
+ },
+ "qualifiedCustomer": {
+ "description": "Customers who qualify for this offer.",
+ "type": "array",
+ "items": {
+ "$ref": "OfferCustomer"
+ }
+ },
+ "terms": {
+ "description": "Terms of the offer.",
+ "type": "string"
+ },
+ "showSpecialOfferCopy": {
+ "description": "Should special text be shown on the offers page.",
+ "type": "boolean"
+ },
+ "available": {
+ "type": "integer",
+ "description": "The number of codes for this offer that are available for distribution.",
+ "format": "int32"
+ },
+ "description": {
+ "description": "Description of the 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": {
@@ -3245,36 +2955,36 @@
"type": "number"
},
"longitude": {
+ "type": "number",
"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
- "format": "double",
- "type": "number"
+ "format": "double"
}
},
- "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."
},
"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"
+ "type": "string",
+ "description": "The 3-letter currency code defined in ISO 4217."
},
"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"
+ },
+ "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"
},
"AnalyticsSummary": {
- "description": "Analytics aggregated data for a `Company` for a given date range.",
"type": "object",
"properties": {
"profileViewsCount": {
@@ -3283,35 +2993,34 @@
"type": "integer"
},
"searchViewsCount": {
+ "type": "integer",
"description": "Aggregated number of times users saw the `Company`\nin Google Partners Search results for given date range.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"contactsCount": {
+ "type": "integer",
"description": "Aggregated number of times users contacted the `Company`\nfor given date range.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
}
},
- "id": "AnalyticsSummary"
+ "id": "AnalyticsSummary",
+ "description": "Analytics aggregated data for a `Company` for a given date range."
},
"LogMessageRequest": {
- "description": "Request message for\nLogClientMessage.",
"type": "object",
"properties": {
"clientInfo": {
- "description": "Map of client info, such as URL, browser navigator, browser platform, etc.",
"type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Map of client info, such as URL, browser navigator, browser platform, etc."
},
"requestMetadata": {
- "description": "Current request metadata.",
- "$ref": "RequestMetadata"
+ "$ref": "RequestMetadata",
+ "description": "Current request metadata."
},
"level": {
- "description": "Message level of client message.",
"type": "string",
"enumDescriptions": [
"Unchosen.",
@@ -3326,30 +3035,32 @@
"ML_INFO",
"ML_WARNING",
"ML_SEVERE"
- ]
+ ],
+ "description": "Message level of client message."
},
"details": {
"description": "Details about the client message.",
"type": "string"
}
},
- "id": "LogMessageRequest"
+ "id": "LogMessageRequest",
+ "description": "Request message for\nLogClientMessage."
},
"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"
+ "type": "string",
+ "description": "Info about the server that serviced this request."
},
"serverTraceInfo": {
- "description": "Server-side debug stack trace.",
- "type": "string"
+ "type": "string",
+ "description": "Server-side debug stack trace."
+ },
+ "serviceUrl": {
+ "type": "string",
+ "description": "URL of the service that handled this request."
}
},
"id": "DebugInfo"
@@ -3358,51 +3069,35 @@
"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": {
- "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."
- ],
- "enum": [
- "LEAD_TYPE_UNSPECIFIED",
- "LT_GPS"
]
},
"minMonthlyBudget": {
- "description": "The minimum monthly budget lead source is willing to spend.",
- "$ref": "Money"
+ "$ref": "Money",
+ "description": "The minimum monthly budget lead source is willing to spend."
},
"givenName": {
- "description": "First name of lead source.",
- "type": "string"
+ "type": "string",
+ "description": "First name of lead source."
},
"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"
+ "type": "string",
+ "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\")."
},
"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",
@@ -3411,15 +3106,16 @@
"OTHER"
],
"description": "The lead's state in relation to the company.",
- "type": "string"
- },
- "gpsMotivations": {
+ "type": "string",
"enumDescriptions": [
"Unchosen.",
- "Advertiser needs help with their advertising.",
- "Advertiser needs help with their website.",
- "Advertiser does not have a website."
- ],
+ "Lead not yet contacted.",
+ "Lead has been contacted.",
+ "Lead has become a client.",
+ "Lead in a state not covered by other options."
+ ]
+ },
+ "gpsMotivations": {
"description": "List of reasons for using Google Partner Search and creating a lead.",
"type": "array",
"items": {
@@ -3430,7 +3126,13 @@
"GPSM_HELP_WITH_WEBSITE",
"GPSM_NO_WEBSITE"
]
- }
+ },
+ "enumDescriptions": [
+ "Unchosen.",
+ "Advertiser needs help with their advertising.",
+ "Advertiser needs help with their website.",
+ "Advertiser does not have a website."
+ ]
},
"email": {
"description": "Email address of lead source.",
@@ -3445,23 +3147,31 @@
"type": "string"
},
"id": {
- "description": "ID of the lead.",
- "type": "string"
+ "type": "string",
+ "description": "ID of the lead."
},
"phoneNumber": {
- "description": "Phone number of lead source.",
- "type": "string"
+ "type": "string",
+ "description": "Phone number of lead source."
},
"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"
}
},
"id": "Lead"
},
"ListUserStatesResponse": {
- "description": "Response message for\nListUserStates.",
"type": "object",
"properties": {
"responseMetadata": {
@@ -3484,87 +3194,15 @@
]
}
},
- "id": "ListUserStatesResponse"
+ "id": "ListUserStatesResponse",
+ "description": "Response message for\nListUserStates."
},
"CompanyRelation": {
"description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners.",
"type": "object",
"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"
- },
- "primaryAddress": {
- "description": "The primary location of the company.",
- "$ref": "Location"
- },
- "state": {
- "description": "The state of relationship, in terms of approvals.",
- "type": "string",
- "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"
- ]
- },
- "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"
- },
"badgeTier": {
+ "type": "string",
"enumDescriptions": [
"Tier badge is not set.",
"Agency has regular partner badge.",
@@ -3575,19 +3213,18 @@
"BADGE_TIER_REGULAR",
"BADGE_TIER_PREMIER"
],
- "description": "Whether the company is a Partner.",
- "type": "string"
+ "description": "Whether the company is a Partner."
},
"specializationStatus": {
- "description": "The list of Google Partners specialization statuses for the company.",
"type": "array",
"items": {
"$ref": "SpecializationStatus"
- }
+ },
+ "description": "The list of Google Partners specialization statuses for the company."
},
"phoneNumber": {
- "description": "The phone number for the company's primary address.",
- "type": "string"
+ "type": "string",
+ "description": "The phone number for the company's primary address."
},
"website": {
"description": "The website URL for this company.",
@@ -3608,19 +3245,92 @@
"logoUrl": {
"description": "A URL to a profile photo, e.g. a G+ profile photo.",
"type": "string"
+ },
+ "resolvedTimestamp": {
+ "type": "string",
+ "description": "The timestamp when the user was approved.\n@OutputOnly",
+ "format": "google-datetime"
+ },
+ "companyAdmin": {
+ "type": "boolean",
+ "description": "Indicates if the user is an admin for this company."
+ },
+ "address": {
+ "description": "The primary address for this company.",
+ "type": "string"
+ },
+ "isPending": {
+ "type": "boolean",
+ "description": "The flag that indicates if the company is pending verification."
+ },
+ "creationTime": {
+ "description": "The timestamp of when affiliation was requested.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "primaryAddress": {
+ "$ref": "Location",
+ "description": "The primary location of the company."
+ },
+ "state": {
+ "type": "string",
+ "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."
+ },
+ "name": {
+ "description": "The name (in the company's primary language) for the company.",
+ "type": "string"
+ },
+ "managerAccount": {
+ "type": "string",
+ "description": "The AdWords manager account # associated this company.",
+ "format": "int64"
+ },
+ "segment": {
+ "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."
+ ],
+ "description": "The segment the company is classified as."
+ },
+ "internalCompanyId": {
+ "type": "string",
+ "description": "The internal company ID.\nOnly available for a whitelisted set of api clients."
}
},
"id": "CompanyRelation"
},
"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": {
+ "type": "integer",
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
- "format": "int32",
- "type": "integer"
+ "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.",
@@ -3632,15 +3342,305 @@
"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": {
+ "trafficSubId": {
+ "type": "string",
+ "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."
+ },
+ "trafficSourceId": {
+ "type": "string",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us."
+ }
+ },
+ "id": "TrafficSource"
+ },
+ "CreateLeadRequest": {
+ "type": "object",
+ "properties": {
+ "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": {
+ "$ref": "RecaptchaChallenge",
+ "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info."
+ },
+ "requestMetadata": {
+ "$ref": "RequestMetadata",
+ "description": "Current request metadata."
+ }
+ },
+ "id": "CreateLeadRequest",
+ "description": "Request message for CreateLead."
+ },
+ "RequestMetadata": {
+ "description": "Common data that is in each API request.",
+ "type": "object",
+ "properties": {
+ "experimentIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Experiment IDs the current request belongs to."
+ },
+ "trafficSource": {
+ "$ref": "TrafficSource",
+ "description": "Source of traffic for the current request."
+ },
+ "locale": {
+ "type": "string",
+ "description": "Locale to use for the current request."
+ },
+ "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": {
+ "type": "string",
+ "description": "Google Partners session ID."
+ }
+ },
+ "id": "RequestMetadata"
+ },
+ "EventData": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "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"
+ ],
+ "description": "Data type."
+ },
+ "values": {
+ "description": "Data values.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "EventData",
+ "description": "Key value data pair for an event."
+ },
+ "ExamStatus": {
+ "type": "object",
+ "properties": {
+ "examType": {
+ "type": "string",
+ "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."
+ },
+ "taken": {
+ "type": "string",
+ "description": "The date the user last taken this exam.",
+ "format": "google-datetime"
+ },
+ "passed": {
+ "type": "boolean",
+ "description": "Whether this exam has been passed and not expired."
+ },
+ "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",
+ "description": "A user's information on a specific exam."
+ },
+ "ListOffersResponse": {
+ "type": "object",
+ "properties": {
+ "noOfferReason": {
+ "type": "string",
+ "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."
+ },
+ "availableOffers": {
+ "type": "array",
+ "items": {
+ "$ref": "AvailableOffer"
+ },
+ "description": "Available Offers to be distributed."
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ }
+ },
+ "id": "ListOffersResponse",
+ "description": "Response for ListOffer."
+ },
+ "CountryOfferInfo": {
+ "type": "object",
+ "properties": {
+ "offerCountryCode": {
+ "description": "Country code for which offer codes may be requested.",
+ "type": "string"
+ },
+ "spendXAmount": {
+ "type": "string",
+ "description": "(localized) Spend X amount for that country's offer."
+ },
+ "offerType": {
+ "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": "Type of offer country is eligible for."
+ },
+ "getYAmount": {
+ "type": "string",
+ "description": "(localized) Get Y amount for that country's offer."
+ }
+ },
+ "id": "CountryOfferInfo",
+ "description": "Offer info by country."
}
- },
- "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"
+ }
}
diff --git a/people/v1/people-api.json b/people/v1/people-api.json
index 97bd7eb..0beb34d 100644
--- a/people/v1/people-api.json
+++ b/people/v1/people-api.json
@@ -1,39 +1,4 @@
{
- "canonicalName": "People Service",
- "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"
- },
- "https://www.googleapis.com/auth/contacts": {
- "description": "Manage your contacts"
- },
- "https://www.googleapis.com/auth/user.addresses.read": {
- "description": "View your street addresses"
- },
- "https://www.googleapis.com/auth/userinfo.email": {
- "description": "View your email address"
- },
- "https://www.googleapis.com/auth/user.phonenumbers.read": {
- "description": "View your phone numbers"
- },
- "https://www.googleapis.com/auth/user.birthday.read": {
- "description": "View your complete date of birth"
- },
- "https://www.googleapis.com/auth/contacts.readonly": {
- "description": "View your contacts"
- }
- }
- }
- },
- "rootUrl": "https://people.googleapis.com/",
"ownerDomain": "google.com",
"name": "people",
"batchPath": "batch",
@@ -41,86 +6,129 @@
"ownerName": "Google",
"resources": {
"people": {
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "resourceName"
- ],
- "response": {
- "$ref": "ListConnectionsResponse"
- },
- "parameters": {
- "syncToken": {
- "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",
- "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",
- "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"
- },
- "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": {
- "description": "The token of the page to be returned.",
- "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"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ],
- "flatPath": "v1/people/{peopleId}/connections",
- "id": "people.people.connections.list",
- "path": "v1/{+resourceName}/connections"
+ "methods": {
+ "getBatchGet": {
+ "path": "v1/people:batchGet",
+ "id": "people.people.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.",
+ "response": {
+ "$ref": "GetPeopleResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "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"
+ },
+ "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"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly",
+ "https://www.googleapis.com/auth/plus.login",
+ "https://www.googleapis.com/auth/user.addresses.read",
+ "https://www.googleapis.com/auth/user.birthday.read",
+ "https://www.googleapis.com/auth/user.emails.read",
+ "https://www.googleapis.com/auth/user.phonenumbers.read",
+ "https://www.googleapis.com/auth/userinfo.email",
+ "https://www.googleapis.com/auth/userinfo.profile"
+ ],
+ "flatPath": "v1/people:batchGet"
+ },
+ "get": {
+ "response": {
+ "$ref": "Person"
+ },
+ "parameterOrder": [
+ "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": {
+ "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/[^/]+$",
+ "location": "path"
+ },
+ "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",
+ "https://www.googleapis.com/auth/plus.login",
+ "https://www.googleapis.com/auth/user.addresses.read",
+ "https://www.googleapis.com/auth/user.birthday.read",
+ "https://www.googleapis.com/auth/user.emails.read",
+ "https://www.googleapis.com/auth/user.phonenumbers.read",
+ "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",
+ "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."
+ },
+ "updateContact": {
+ "flatPath": "v1/people/{peopleId}:updateContact",
+ "path": "v1/{+resourceName}:updateContact",
+ "id": "people.people.updateContact",
+ "description": "Update contact data for an existing contact person. Any non-contact data\nwill not be modified.\n\nThe request throws a 400 error if `updatePersonFields` is not specified.\n\u003cbr\u003e\nThe request throws a 400 error if `person.metadata.sources` is not\nspecified for the contact to be updated.\n\u003cbr\u003e\nThe request throws a 412 error if `person.metadata.sources.etag` is\ndifferent than the contact's etag, which indicates the contact has changed\nsince its data was read. Clients should get the latest person and re-apply\ntheir updates to the latest person.",
+ "request": {
+ "$ref": "Person"
+ },
+ "response": {
+ "$ref": "Person"
+ },
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "parameters": {
+ "updatePersonFields": {
+ "location": "query",
+ "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",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "resourceName": {
+ "pattern": "^people/[^/]+$",
+ "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"
}
}
- }
- },
- "methods": {
+ },
"createContact": {
- "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"
@@ -135,272 +143,119 @@
],
"parameters": {
"parent": {
- "location": "query",
"description": "The resource name of the owning person resource.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
- }
+ },
+ "flatPath": "v1/people:createContact",
+ "path": "v1/people:createContact",
+ "id": "people.people.createContact"
},
"deleteContact": {
+ "id": "people.people.deleteContact",
+ "path": "v1/{+resourceName}:deleteContact",
+ "description": "Delete a contact person. Any non-contact data will not be deleted.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "resourceName"
+ ],
"response": {
"$ref": "Empty"
},
- "parameterOrder": [
- "resourceName"
- ],
- "httpMethod": "DELETE",
"parameters": {
"resourceName": {
+ "location": "path",
"description": "The resource name of the contact to delete.",
"required": true,
"type": "string",
- "pattern": "^people/[^/]+$",
- "location": "path"
+ "pattern": "^people/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/contacts"
],
- "flatPath": "v1/people/{peopleId}:deleteContact",
- "path": "v1/{+resourceName}:deleteContact",
- "id": "people.people.deleteContact",
- "description": "Delete a contact person. Any non-contact data will not be deleted."
- },
- "getBatchGet": {
- "response": {
- "$ref": "GetPeopleResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly",
- "https://www.googleapis.com/auth/plus.login",
- "https://www.googleapis.com/auth/user.addresses.read",
- "https://www.googleapis.com/auth/user.birthday.read",
- "https://www.googleapis.com/auth/user.emails.read",
- "https://www.googleapis.com/auth/user.phonenumbers.read",
- "https://www.googleapis.com/auth/userinfo.email",
- "https://www.googleapis.com/auth/userinfo.profile"
- ],
- "parameters": {
- "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"
- },
- "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": {
- "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"
+ "flatPath": "v1/people/{peopleId}:deleteContact"
+ }
+ },
+ "resources": {
+ "connections": {
+ "methods": {
+ "list": {
+ "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.",
+ "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"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The token of the page to be returned.",
+ "type": "string"
+ },
+ "resourceName": {
+ "pattern": "^people/[^/]+$",
+ "location": "path",
+ "description": "The resource name to return connections for. Only `people/me` is valid.",
+ "required": true,
+ "type": "string"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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": {
+ "description": "The order in which the connections should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "LAST_MODIFIED_ASCENDING",
+ "FIRST_NAME_ASCENDING",
+ "LAST_NAME_ASCENDING"
+ ]
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly"
+ ]
}
- },
- "flatPath": "v1/people:batchGet",
- "path": "v1/people:batchGet",
- "id": "people.people.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."
- },
- "get": {
- "response": {
- "$ref": "Person"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly",
- "https://www.googleapis.com/auth/plus.login",
- "https://www.googleapis.com/auth/user.addresses.read",
- "https://www.googleapis.com/auth/user.birthday.read",
- "https://www.googleapis.com/auth/user.emails.read",
- "https://www.googleapis.com/auth/user.phonenumbers.read",
- "https://www.googleapis.com/auth/userinfo.email",
- "https://www.googleapis.com/auth/userinfo.profile"
- ],
- "parameters": {
- "resourceName": {
- "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/[^/]+$",
- "location": "path"
- },
- "personFields": {
- "location": "query",
- "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"
- },
- "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"
- }
- },
- "flatPath": "v1/people/{peopleId}",
- "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."
- },
- "updateContact": {
- "request": {
- "$ref": "Person"
- },
- "description": "Update contact data for an existing contact person. Any non-contact data\nwill not be modified.\n\nThe request throws a 400 error if `updatePersonFields` is not specified.\n\u003cbr\u003e\nThe request throws a 400 error if `person.metadata.sources` is not\nspecified for the contact to be updated.\n\u003cbr\u003e\nThe request throws a 412 error if `person.metadata.sources.etag` is\ndifferent than the contact's etag, which indicates the contact has changed\nsince its data was read. Clients should get the latest person and re-apply\ntheir updates to the latest person.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "resourceName"
- ],
- "response": {
- "$ref": "Person"
- },
- "parameters": {
- "resourceName": {
- "pattern": "^people/[^/]+$",
- "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"
- },
- "updatePersonFields": {
- "location": "query",
- "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",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
- "flatPath": "v1/people/{peopleId}:updateContact",
- "id": "people.people.updateContact",
- "path": "v1/{+resourceName}:updateContact"
+ }
}
}
},
"contactGroups": {
"methods": {
- "batchGet": {
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ],
- "parameters": {
- "maxMembers": {
- "description": "Specifies the maximum number of members to return for each group.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "resourceNames": {
- "location": "query",
- "description": "The resource names of the contact groups to get.",
- "type": "string",
- "repeated": true
- }
- },
- "flatPath": "v1/contactGroups:batchGet",
- "path": "v1/contactGroups:batchGet",
- "id": "people.contactGroups.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"
- },
- "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": {
- "location": "query",
- "description": "Set to true to also delete the contacts in the specified group.",
- "type": "boolean"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
- "flatPath": "v1/contactGroups/{contactGroupsId}"
- },
- "list": {
- "flatPath": "v1/contactGroups",
- "path": "v1/contactGroups",
- "id": "people.contactGroups.list",
- "description": "List all contact groups owned by the authenticated user. Members of the\ncontact groups are not populated.",
- "response": {
- "$ref": "ListContactGroupsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "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"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "The maximum number of resources to return.",
- "format": "int32"
- },
- "syncToken": {
- "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",
- "location": "query"
- }
- }
- },
- "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": {
"flatPath": "v1/contactGroups/{contactGroupsId}",
"path": "v1/{+resourceName}",
@@ -419,59 +274,167 @@
],
"parameters": {
"maxMembers": {
- "location": "query",
"description": "Specifies the maximum number of members to return.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "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"
}
}
},
"update": {
- "request": {
- "$ref": "UpdateContactGroupRequest"
- },
- "description": "Update the name of an existing contact group owned by the authenticated\nuser.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "resourceName"
- ],
"response": {
"$ref": "ContactGroup"
},
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
"parameters": {
"resourceName": {
- "pattern": "^contactGroups/[^/]+$",
- "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"
+ }
+ },
+ "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"
+ }
+ },
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "parameters": {
+ "resourceName": {
+ "description": "The resource name of the contact group to delete.",
+ "required": true,
+ "type": "string",
+ "pattern": "^contactGroups/[^/]+$",
+ "location": "path"
+ },
+ "deleteContacts": {
+ "description": "Set to true to also delete the contacts in the specified group.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/contactGroups/{contactGroupsId}",
+ "path": "v1/{+resourceName}",
+ "id": "people.contactGroups.delete"
+ },
+ "batchGet": {
+ "response": {
+ "$ref": "BatchGetContactGroupsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "maxMembers": {
+ "location": "query",
+ "description": "Specifies the maximum number of members to return for each group.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "resourceNames": {
+ "repeated": true,
+ "location": "query",
+ "description": "The resource names of the contact groups to get.",
"type": "string"
}
},
"scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly"
+ ],
+ "flatPath": "v1/contactGroups:batchGet",
+ "path": "v1/contactGroups:batchGet",
+ "id": "people.contactGroups.batchGet",
+ "description": "Get a list of contact groups owned by the authenticated user by specifying\na list of contact group resource names."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListContactGroupsResponse"
+ },
+ "parameterOrder": [],
+ "parameters": {
+ "syncToken": {
+ "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",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "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"
+ },
+ "pageSize": {
+ "description": "The maximum number of resources to return.",
+ "format": "int32",
+ "type": "integer",
+ "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",
+ "description": "List all contact groups owned by the authenticated user. Members of the\ncontact groups are not populated."
+ },
+ "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"
],
- "flatPath": "v1/contactGroups/{contactGroupsId}",
- "id": "people.contactGroups.update",
- "path": "v1/{+resourceName}"
+ "parameters": {},
+ "flatPath": "v1/contactGroups",
+ "path": "v1/contactGroups",
+ "id": "people.contactGroups.create"
}
},
"resources": {
"members": {
"methods": {
"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"
},
@@ -479,19 +442,21 @@
"resourceName"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/contacts"
- ],
"parameters": {
"resourceName": {
+ "location": "path",
"description": "The resource name of the contact group to modify.",
"required": true,
"type": "string",
- "pattern": "^contactGroups/[^/]+$",
- "location": "path"
+ "pattern": "^contactGroups/[^/]+$"
}
},
- "flatPath": "v1/contactGroups/{contactGroupsId}/members:modify"
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts"
+ ],
+ "flatPath": "v1/contactGroups/{contactGroupsId}/members:modify",
+ "path": "v1/{+resourceName}/members:modify",
+ "id": "people.contactGroups.members.modify"
}
}
}
@@ -499,74 +464,32 @@
}
},
"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": {
- "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"
+ "default": "true",
+ "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",
"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",
@@ -580,10 +503,52 @@
"description": "V1 error format.",
"type": "string"
},
- "callback": {
- "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": "JSONP"
+ "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"
+ },
+ "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": "v1",
@@ -598,22 +563,156 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "DomainMembership": {
+ "properties": {
+ "inViewerDomain": {
+ "description": "True if the person is in the viewer's Google Apps domain.",
+ "type": "boolean"
+ }
+ },
+ "id": "DomainMembership",
+ "description": "A Google Apps Domain membership.",
+ "type": "object"
+ },
+ "Membership": {
+ "properties": {
+ "contactGroupMembership": {
+ "$ref": "ContactGroupMembership",
+ "description": "The contact group membership."
+ },
+ "domainMembership": {
+ "$ref": "DomainMembership",
+ "description": "The domain membership."
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the membership."
+ }
+ },
+ "id": "Membership",
+ "description": "A person's read-only membership in a group.",
+ "type": "object"
+ },
+ "BatchGetContactGroupsResponse": {
+ "properties": {
+ "responses": {
+ "description": "The list of responses for each requested contact group resource.",
+ "type": "array",
+ "items": {
+ "$ref": "ContactGroupResponse"
+ }
+ }
+ },
+ "id": "BatchGetContactGroupsResponse",
+ "description": "The response to a batch get contact groups request.",
+ "type": "object"
+ },
+ "RelationshipStatus": {
+ "properties": {
+ "metadata": {
+ "description": "Metadata about the relationship status.",
+ "$ref": "FieldMetadata"
+ },
+ "value": {
+ "description": "The relationship status. The value can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplicated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilUnion`",
+ "type": "string"
+ },
+ "formattedValue": {
+ "description": "The read-only value of the relationship status translated and formatted in\nthe viewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ }
+ },
+ "id": "RelationshipStatus",
+ "description": "A person's read-only relationship status.",
+ "type": "object"
+ },
+ "BraggingRights": {
+ "description": "A person's bragging rights.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "description": "Metadata about the bragging rights.",
+ "$ref": "FieldMetadata"
+ },
+ "value": {
+ "description": "The bragging rights; for example, `climbed mount everest`.",
+ "type": "string"
+ }
+ },
+ "id": "BraggingRights"
+ },
+ "Organization": {
+ "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
+ "type": "object",
+ "properties": {
+ "endDate": {
+ "$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.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the organization.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the organization."
+ },
+ "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": {
+ "$ref": "Date",
+ "description": "The start date when the person joined the organization."
+ },
+ "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"
+ },
+ "domain": {
+ "description": "The domain name associated with the organization; for example, `google.com`.",
+ "type": "string"
+ },
+ "department": {
+ "description": "The person's department at the organization.",
+ "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"
+ }
+ },
+ "id": "Organization"
+ },
"AgeRangeType": {
- "id": "AgeRangeType",
"description": "A person's age range.",
"type": "object",
"properties": {
"metadata": {
- "description": "Metadata about the age range.",
- "$ref": "FieldMetadata"
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the age range."
},
"ageRange": {
- "enumDescriptions": [
- "Unspecified.",
- "Younger than eighteen.",
- "Between eighteen and twenty.",
- "Twenty-one and older."
- ],
"enum": [
"AGE_RANGE_UNSPECIFIED",
"LESS_THAN_EIGHTEEN",
@@ -621,14 +720,28 @@
"TWENTY_ONE_OR_OLDER"
],
"description": "The age range.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Younger than eighteen.",
+ "Between eighteen and twenty.",
+ "Twenty-one and older."
+ ]
}
- }
+ },
+ "id": "AgeRangeType"
},
"ListContactGroupsResponse": {
"description": "The response to a list contact groups request.",
"type": "object",
"properties": {
+ "contactGroups": {
+ "description": "The list of contact groups. Members of the contact groups are not\npopulated.",
+ "type": "array",
+ "items": {
+ "$ref": "ContactGroup"
+ }
+ },
"nextPageToken": {
"description": "The token that can be used to retrieve the next page of results.",
"type": "string"
@@ -641,13 +754,6 @@
"nextSyncToken": {
"description": "The token that can be used to retrieve changes since the last request.",
"type": "string"
- },
- "contactGroups": {
- "description": "The list of contact groups. Members of the contact groups are not\npopulated.",
- "type": "array",
- "items": {
- "$ref": "ContactGroup"
- }
}
},
"id": "ListContactGroupsResponse"
@@ -661,8 +767,8 @@
"description": "The person."
},
"status": {
- "$ref": "Status",
- "description": "The status of the response."
+ "description": "The status of the response.",
+ "$ref": "Status"
},
"httpStatusCode": {
"description": "**DEPRECATED** (Please use status instead)\n\n[HTTP 1.1 status code]\n(http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).",
@@ -685,8 +791,8 @@
"description": "Metadata about the relation."
},
"type": {
- "type": "string",
- "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`"
+ "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`",
+ "type": "string"
},
"person": {
"description": "The name of the other person this relation refers to.",
@@ -702,8 +808,8 @@
"Occupation": {
"properties": {
"metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the occupation."
+ "description": "Metadata about the occupation.",
+ "$ref": "FieldMetadata"
},
"value": {
"description": "The occupation; for example, `carpenter`.",
@@ -718,17 +824,11 @@
"description": "A contact group.",
"type": "object",
"properties": {
- "resourceName": {
- "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.",
- "type": "string"
- },
- "etag": {
- "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
+ "formattedName": {
+ "description": "The read-only name translated and formatted in the viewer's account locale\nor the `Accept-Language` HTTP header locale for system groups names.\nGroup names set by the owner are the same as name.",
"type": "string"
},
"groupType": {
- "description": "The read-only contact group type.",
- "type": "string",
"enumDescriptions": [
"Unspecified.",
"User defined contact group.",
@@ -738,15 +838,13 @@
"GROUP_TYPE_UNSPECIFIED",
"USER_CONTACT_GROUP",
"SYSTEM_CONTACT_GROUP"
- ]
- },
- "formattedName": {
- "description": "The read-only name translated and formatted in the viewer's account locale\nor the `Accept-Language` HTTP header locale for system groups names.\nGroup names set by the owner are the same as name.",
+ ],
+ "description": "The read-only contact group type.",
"type": "string"
},
"name": {
- "type": "string",
- "description": "The contact group name set by the group owner or a system provided name\nfor system groups."
+ "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).",
@@ -755,14 +853,22 @@
"type": "string"
}
},
+ "metadata": {
+ "$ref": "ContactGroupMetadata",
+ "description": "Metadata about the contact group."
+ },
"memberCount": {
"description": "The total number of contacts in the group irrespective of max members in\nspecified in the request.",
"format": "int32",
"type": "integer"
},
- "metadata": {
- "$ref": "ContactGroupMetadata",
- "description": "Metadata about the contact group."
+ "resourceName": {
+ "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.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
+ "type": "string"
}
},
"id": "ContactGroup"
@@ -771,160 +877,6 @@
"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": {
- "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"
- }
- },
- "occupations": {
- "description": "The person's occupations.",
- "type": "array",
- "items": {
- "$ref": "Occupation"
- }
- },
- "emailAddresses": {
- "description": "The person's email addresses.",
- "type": "array",
- "items": {
- "$ref": "EmailAddress"
- }
- },
- "organizations": {
- "description": "The person's past or current organizations.",
- "type": "array",
- "items": {
- "$ref": "Organization"
- }
- },
- "etag": {
- "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
- "type": "string"
- },
- "braggingRights": {
- "description": "The person's bragging rights.",
- "type": "array",
- "items": {
- "$ref": "BraggingRights"
- }
- },
- "metadata": {
- "description": "Read-only metadata about the person.",
- "$ref": "PersonMetadata"
- },
- "residences": {
- "description": "The person's residences.",
- "type": "array",
- "items": {
- "$ref": "Residence"
- }
- },
- "genders": {
- "description": "The person's genders.",
- "type": "array",
- "items": {
- "$ref": "Gender"
- }
- },
- "resourceName": {
- "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.",
- "type": "string"
- },
- "interests": {
- "description": "The person's interests.\n**DEPRECATED** (No values will be returned.)",
- "type": "array",
- "items": {
- "$ref": "Interest"
- }
- },
- "biographies": {
- "description": "The person's biographies.",
- "type": "array",
- "items": {
- "$ref": "Biography"
- }
- },
- "skills": {
- "description": "The person's skills.",
- "type": "array",
- "items": {
- "$ref": "Skill"
- }
- },
- "relationshipStatuses": {
- "description": "The person's read-only relationship statuses.",
- "type": "array",
- "items": {
- "$ref": "RelationshipStatus"
- }
- },
- "photos": {
- "description": "The person's read-only photos.",
- "type": "array",
- "items": {
- "$ref": "Photo"
- }
- },
- "ageRange": {
- "enumDescriptions": [
- "Unspecified.",
- "Younger than eighteen.",
- "Between eighteen and twenty.",
- "Twenty-one and older."
- ],
- "enum": [
- "AGE_RANGE_UNSPECIFIED",
- "LESS_THAN_EIGHTEEN",
- "EIGHTEEN_TO_TWENTY",
- "TWENTY_ONE_OR_OLDER"
- ],
- "description": "**DEPRECATED** (Please use `person.ageRanges` instead)**\n\nThe person's read-only age range.",
- "type": "string"
- },
- "taglines": {
- "description": "The person's read-only taglines.",
- "type": "array",
- "items": {
- "$ref": "Tagline"
- }
- },
- "ageRanges": {
- "description": "The person's read-only age ranges.",
- "type": "array",
- "items": {
- "$ref": "AgeRangeType"
- }
- },
- "addresses": {
- "description": "The person's street addresses.",
- "type": "array",
- "items": {
- "$ref": "Address"
- }
- },
- "events": {
- "description": "The person's events.",
- "type": "array",
- "items": {
- "$ref": "Event"
- }
- },
"memberships": {
"description": "The person's read-only group memberships.",
"type": "array",
@@ -987,6 +939,160 @@
"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",
+ "items": {
+ "$ref": "Occupation"
+ }
+ },
+ "emailAddresses": {
+ "description": "The person's email addresses.",
+ "type": "array",
+ "items": {
+ "$ref": "EmailAddress"
+ }
+ },
+ "organizations": {
+ "description": "The person's past or current organizations.",
+ "type": "array",
+ "items": {
+ "$ref": "Organization"
+ }
+ },
+ "etag": {
+ "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
+ "type": "string"
+ },
+ "braggingRights": {
+ "description": "The person's bragging rights.",
+ "type": "array",
+ "items": {
+ "$ref": "BraggingRights"
+ }
+ },
+ "metadata": {
+ "$ref": "PersonMetadata",
+ "description": "Read-only metadata about the person."
+ },
+ "residences": {
+ "description": "The person's residences.",
+ "type": "array",
+ "items": {
+ "$ref": "Residence"
+ }
+ },
+ "genders": {
+ "description": "The person's genders.",
+ "type": "array",
+ "items": {
+ "$ref": "Gender"
+ }
+ },
+ "interests": {
+ "description": "The person's interests.\n**DEPRECATED** (No values will be returned.)",
+ "type": "array",
+ "items": {
+ "$ref": "Interest"
+ }
+ },
+ "resourceName": {
+ "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.",
+ "type": "string"
+ },
+ "biographies": {
+ "description": "The person's biographies.",
+ "type": "array",
+ "items": {
+ "$ref": "Biography"
+ }
+ },
+ "skills": {
+ "description": "The person's skills.",
+ "type": "array",
+ "items": {
+ "$ref": "Skill"
+ }
+ },
+ "relationshipStatuses": {
+ "description": "The person's read-only relationship statuses.",
+ "type": "array",
+ "items": {
+ "$ref": "RelationshipStatus"
+ }
+ },
+ "photos": {
+ "description": "The person's read-only photos.",
+ "type": "array",
+ "items": {
+ "$ref": "Photo"
+ }
+ },
+ "ageRange": {
+ "description": "**DEPRECATED** (Please use `person.ageRanges` instead)**\n\nThe person's read-only age range.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Younger than eighteen.",
+ "Between eighteen and twenty.",
+ "Twenty-one and older."
+ ],
+ "enum": [
+ "AGE_RANGE_UNSPECIFIED",
+ "LESS_THAN_EIGHTEEN",
+ "EIGHTEEN_TO_TWENTY",
+ "TWENTY_ONE_OR_OLDER"
+ ]
+ },
+ "taglines": {
+ "description": "The person's read-only taglines.",
+ "type": "array",
+ "items": {
+ "$ref": "Tagline"
+ }
+ },
+ "ageRanges": {
+ "description": "The person's read-only age ranges.",
+ "type": "array",
+ "items": {
+ "$ref": "AgeRangeType"
+ }
+ },
+ "addresses": {
+ "description": "The person's street addresses.",
+ "type": "array",
+ "items": {
+ "$ref": "Address"
+ }
+ },
+ "events": {
+ "description": "The person's events.",
+ "type": "array",
+ "items": {
+ "$ref": "Event"
+ }
}
},
"id": "Person"
@@ -1011,9 +1117,9 @@
"type": "boolean"
},
"updateTime": {
- "type": "string",
"description": "The time the group was last updated.",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
}
},
"id": "ContactGroupMetadata"
@@ -1022,47 +1128,45 @@
"description": "A person's past or current residence.",
"type": "object",
"properties": {
+ "value": {
+ "description": "The address of the residence.",
+ "type": "string"
+ },
"metadata": {
- "description": "Metadata about the residence.",
- "$ref": "FieldMetadata"
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the residence."
},
"current": {
"description": "True if the residence is the person's current residence;\nfalse if the residence is a past residence.",
"type": "boolean"
- },
- "value": {
- "description": "The address of the residence.",
- "type": "string"
}
},
"id": "Residence"
},
"Event": {
+ "description": "An event related to the person.",
"type": "object",
"properties": {
"formattedType": {
- "type": "string",
- "description": "The read-only type of the event translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale."
+ "description": "The read-only type of the event translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
},
"metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the event."
+ "description": "Metadata about the event.",
+ "$ref": "FieldMetadata"
},
"type": {
"description": "The type of the event. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `anniversary`\n* `other`",
"type": "string"
},
"date": {
- "$ref": "Date",
- "description": "The date of the event."
+ "description": "The date of the event.",
+ "$ref": "Date"
}
},
- "id": "Event",
- "description": "An event related to the person."
+ "id": "Event"
},
"ModifyContactGroupMembersResponse": {
- "description": "The response to a modify contact group members request.",
- "type": "object",
"properties": {
"notFoundResourceNames": {
"description": "The contact people resource names that were not found.",
@@ -1072,13 +1176,16 @@
}
}
},
- "id": "ModifyContactGroupMembersResponse"
+ "id": "ModifyContactGroupMembersResponse",
+ "description": "The response to a modify contact group members request.",
+ "type": "object"
},
"ProfileMetadata": {
"description": "The read-only metadata about a profile.",
"type": "object",
"properties": {
"objectType": {
+ "description": "The profile object type.",
"type": "string",
"enumDescriptions": [
"Unspecified.",
@@ -1089,27 +1196,26 @@
"OBJECT_TYPE_UNSPECIFIED",
"PERSON",
"PAGE"
- ],
- "description": "The profile object type."
+ ]
},
"userTypes": {
- "description": "The user types.",
- "type": "array",
- "items": {
- "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."
- ]
+ ],
+ "description": "The user types.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "USER_TYPE_UNKNOWN",
+ "GOOGLE_USER",
+ "GPLUS_USER",
+ "GOOGLE_APPS_USER"
+ ]
+ }
}
},
"id": "ProfileMetadata"
@@ -1123,8 +1229,8 @@
"type": "string"
},
"metadata": {
- "description": "Metadata about the gender.",
- "$ref": "FieldMetadata"
+ "$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`",
@@ -1138,8 +1244,8 @@
"type": "object",
"properties": {
"metadata": {
- "description": "Metadata about the cover photo.",
- "$ref": "FieldMetadata"
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the cover photo."
},
"default": {
"description": "True if the cover photo is the default cover photo;\nfalse if the cover photo is a user-provided cover photo.",
@@ -1153,58 +1259,27 @@
"id": "CoverPhoto"
},
"Interest": {
- "id": "Interest",
"description": "One of the person's interests.\n**DEPRECATED** (Message will not be returned.)",
"type": "object",
"properties": {
- "metadata": {
- "description": "Metadata about the interest.",
- "$ref": "FieldMetadata"
- },
"value": {
"description": "The interest; for example, `stargazing`.",
"type": "string"
- }
- }
- },
- "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": {
- "type": "string",
- "description": "The display name of the email."
},
"metadata": {
- "description": "Metadata about the email address.",
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the interest."
+ }
+ },
+ "id": "Interest"
+ },
+ "Nickname": {
+ "properties": {
+ "metadata": {
+ "description": "Metadata about the nickname.",
"$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"
- }
- },
- "id": "EmailAddress"
- },
- "Nickname": {
- "description": "A person's nickname.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the nickname."
- },
- "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.",
@@ -1218,16 +1293,49 @@
"INITIALS",
"GPLUS",
"OTHER_NAME"
- ]
+ ],
+ "description": "The type of the nickname.",
+ "type": "string"
},
"value": {
"description": "The nickname.",
"type": "string"
}
},
- "id": "Nickname"
+ "id": "Nickname",
+ "description": "A person's nickname.",
+ "type": "object"
+ },
+ "EmailAddress": {
+ "description": "A person's email address.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "EmailAddress"
},
"Skill": {
+ "description": "A skill that the person has.",
+ "type": "object",
"properties": {
"metadata": {
"description": "Metadata about the skill.",
@@ -1238,9 +1346,7 @@
"type": "string"
}
},
- "id": "Skill",
- "description": "A skill that the person has.",
- "type": "object"
+ "id": "Skill"
},
"Tagline": {
"description": "A read-only brief one-line description of the person.",
@@ -1261,6 +1367,11 @@
"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": {
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
+ "format": "int32",
+ "type": "integer"
+ },
"year": {
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"format": "int32",
@@ -1270,35 +1381,12 @@
"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": {
- "honorificPrefix": {
- "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
- "type": "string"
- },
- "phoneticHonorificSuffix": {
- "description": "The honorific suffixes spelled as they sound.",
- "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"
@@ -1312,16 +1400,16 @@
"type": "string"
},
"familyName": {
- "type": "string",
- "description": "The family name."
+ "description": "The family name.",
+ "type": "string"
},
"phoneticMiddleName": {
"description": "The middle name(s) spelled as they sound.",
"type": "string"
},
"metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the name."
+ "description": "Metadata about the name.",
+ "$ref": "FieldMetadata"
},
"phoneticFullName": {
"description": "The full name spelled as it sounds.",
@@ -1338,25 +1426,43 @@
"honorificSuffix": {
"description": "The honorific suffixes, such as `Jr.`",
"type": "string"
- }
- },
- "id": "Name"
- },
- "Locale": {
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the locale."
},
- "value": {
- "description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)\nlanguage tag representing the locale.",
+ "honorificPrefix": {
+ "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
+ "type": "string"
+ },
+ "phoneticHonorificSuffix": {
+ "description": "The honorific suffixes spelled as they sound.",
+ "type": "string"
+ },
+ "middleName": {
+ "description": "The middle name(s).",
+ "type": "string"
+ },
+ "givenName": {
+ "description": "The given name.",
"type": "string"
}
},
- "id": "Locale",
- "description": "A person's locale preference.",
+ "id": "Name",
+ "description": "A person's name. If the name is a mononym, the family name is empty.",
"type": "object"
},
+ "Locale": {
+ "description": "A person's locale preference.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)\nlanguage tag representing the locale.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the locale."
+ }
+ },
+ "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",
@@ -1367,10 +1473,6 @@
"description": "Arbitrary user data that is populated by the end users.",
"type": "object",
"properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the user defined data."
- },
"value": {
"description": "The end user specified value of the user defined data.",
"type": "string"
@@ -1378,13 +1480,15 @@
"key": {
"description": "The end user specified key of the user defined data.",
"type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the user defined data."
}
},
"id": "UserDefined"
},
"Biography": {
- "description": "A person's short biography.",
- "type": "object",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
@@ -1395,27 +1499,32 @@
"type": "string"
},
"contentType": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "Plain text.",
+ "HTML text."
+ ],
"enum": [
"CONTENT_TYPE_UNSPECIFIED",
"TEXT_PLAIN",
"TEXT_HTML"
],
"description": "The content type of the biography.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Plain text.",
- "HTML text."
- ]
+ "type": "string"
}
},
- "id": "Biography"
+ "id": "Biography",
+ "description": "A person's short biography.",
+ "type": "object"
},
"FieldMetadata": {
- "id": "FieldMetadata",
"description": "Metadata about a field.",
"type": "object",
"properties": {
+ "verified": {
+ "description": "True if the field is verified; false if the field is unverified. A\nverified field is typically a name, email address, phone number, or\nwebsite that has been confirmed to be owned by the person.",
+ "type": "boolean"
+ },
"primary": {
"description": "True if the field is the primary field; false if the field is a secondary\nfield.",
"type": "boolean"
@@ -1423,12 +1532,28 @@
"source": {
"description": "The source of the field.",
"$ref": "Source"
- },
- "verified": {
- "description": "True if the field is verified; false if the field is unverified. A\nverified field is typically a name, email address, phone number, or\nwebsite that has been confirmed to be owned by the person.",
- "type": "boolean"
}
- }
+ },
+ "id": "FieldMetadata"
+ },
+ "RelationshipInterest": {
+ "description": "A person's read-only relationship interest .",
+ "type": "object",
+ "properties": {
+ "formattedValue": {
+ "description": "The value of the relationship interest translated and formatted in the\nviewer's account locale or the locale specified in the Accept-Language\nHTTP header.",
+ "type": "string"
+ },
+ "metadata": {
+ "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`",
+ "type": "string"
+ }
+ },
+ "id": "RelationshipInterest"
},
"Source": {
"description": "The source of a field.",
@@ -1472,42 +1597,50 @@
},
"id": "Source"
},
- "RelationshipInterest": {
- "type": "object",
- "properties": {
- "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`",
- "type": "string"
- },
- "formattedValue": {
- "description": "The value of the relationship interest translated and formatted in the\nviewer's account locale or the locale specified in the Accept-Language\nHTTP header.",
- "type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the relationship interest."
- }
- },
- "id": "RelationshipInterest",
- "description": "A person's read-only relationship interest ."
- },
"GetPeopleResponse": {
"type": "object",
"properties": {
"responses": {
+ "description": "The response for each requested resource name.",
"type": "array",
"items": {
"$ref": "PersonResponse"
- },
- "description": "The response for each requested resource name."
+ }
}
},
"id": "GetPeopleResponse"
},
+ "Photo": {
+ "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the photo."
+ },
+ "default": {
+ "description": "True if the photo is a default photo;\nfalse if the photo is a user-provided photo.",
+ "type": "boolean"
+ },
+ "url": {
+ "description": "The URL of the photo. You can change the desired size by appending a query\nparameter `sz=`\u003cvar\u003esize\u003c/var\u003e at the end of the url. Example:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`",
+ "type": "string"
+ }
+ },
+ "id": "Photo"
+ },
"PhoneNumber": {
"description": "A person's phone number.",
"type": "object",
"properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the phone number."
+ },
+ "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`",
+ "type": "string"
+ },
"value": {
"description": "The phone number.",
"type": "string"
@@ -1517,47 +1650,15 @@
"type": "string"
},
"canonicalForm": {
- "type": "string",
- "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."
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the phone number."
- },
- "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`",
+ "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"
},
- "Photo": {
- "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.",
- "type": "object",
- "properties": {
- "metadata": {
- "description": "Metadata about the photo.",
- "$ref": "FieldMetadata"
- },
- "default": {
- "description": "True if the photo is a default photo;\nfalse if the photo is a user-provided photo.",
- "type": "boolean"
- },
- "url": {
- "type": "string",
- "description": "The URL of the photo. You can change the desired size by appending a query\nparameter `sz=`\u003cvar\u003esize\u003c/var\u003e at the end of the url. Example:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`"
- }
- },
- "id": "Photo"
- },
"ListConnectionsResponse": {
"type": "object",
"properties": {
- "totalPeople": {
- "description": "**DEPRECATED** (Please use totalItems)\nThe total number of people in the list without pagination.",
- "format": "int32",
- "type": "integer"
- },
"nextPageToken": {
"description": "The token that can be used to retrieve the next page of results.",
"type": "string"
@@ -1577,6 +1678,11 @@
"description": "The total number of items in the list without pagination.",
"format": "int32",
"type": "integer"
+ },
+ "totalPeople": {
+ "description": "**DEPRECATED** (Please use totalItems)\nThe total number of people in the list without pagination.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "ListConnectionsResponse"
@@ -1612,10 +1718,17 @@
"id": "CreateContactGroupRequest"
},
"Address": {
- "id": "Address",
"description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
"type": "object",
"properties": {
+ "streetAddress": {
+ "description": "The street address.",
+ "type": "string"
+ },
+ "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"
@@ -1655,30 +1768,25 @@
"region": {
"description": "The region of the address; for example, the state or province.",
"type": "string"
- },
- "streetAddress": {
- "description": "The street address.",
- "type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the address."
}
- }
+ },
+ "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",
"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",
@@ -1687,45 +1795,23 @@
"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",
- "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"
- },
- "ContactGroupMembership": {
- "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",
- "description": "A Google contact group membership."
+ "id": "Status"
},
"PersonMetadata": {
- "description": "The read-only metadata about a person.",
- "type": "object",
"properties": {
- "deleted": {
- "description": "True if the person resource has been deleted. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connections/list) requests\nthat include a sync token.",
- "type": "boolean"
- },
- "objectType": {
- "description": "**DEPRECATED** (Please use\n`person.metadata.sources.profileMetadata.objectType` instead)\n\nThe type of the person object.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Person.",
- "[Google+ Page.](http://www.google.com/+/brands/)"
- ],
- "enum": [
- "OBJECT_TYPE_UNSPECIFIED",
- "PERSON",
- "PAGE"
- ]
- },
"linkedPeopleResourceNames": {
"description": "Resource names of people linked to this resource.",
"type": "array",
@@ -1746,37 +1832,53 @@
"items": {
"type": "string"
}
+ },
+ "deleted": {
+ "description": "True if the person resource has been deleted. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connections/list) requests\nthat include a sync token.",
+ "type": "boolean"
+ },
+ "objectType": {
+ "enum": [
+ "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",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Person.",
+ "[Google+ Page.](http://www.google.com/+/brands/)"
+ ]
}
},
- "id": "PersonMetadata"
+ "id": "PersonMetadata",
+ "description": "The read-only metadata about a person.",
+ "type": "object"
},
"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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"resourceNamesToRemove": {
"description": "The resource names of the contact people to remove in the form of in the\nform of `people/`\u003cvar\u003eperson_id\u003c/var\u003e.",
"type": "array",
"items": {
"type": "string"
}
- },
- "resourceNamesToAdd": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "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."
}
},
- "id": "ModifyContactGroupMembersRequest"
+ "id": "ModifyContactGroupMembersRequest",
+ "description": "A request to modify an existing contact group's members.",
+ "type": "object"
},
"ContactGroupResponse": {
"properties": {
- "requestedResourceName": {
- "description": "The original requested resource name.",
- "type": "string"
- },
"contactGroup": {
"description": "The contact group.",
"$ref": "ContactGroup"
@@ -1784,6 +1886,10 @@
"status": {
"$ref": "Status",
"description": "The status of the response."
+ },
+ "requestedResourceName": {
+ "description": "The original requested resource name.",
+ "type": "string"
}
},
"id": "ContactGroupResponse",
@@ -1791,7 +1897,6 @@
"type": "object"
},
"Url": {
- "type": "object",
"properties": {
"value": {
"description": "The URL.",
@@ -1811,9 +1916,11 @@
}
},
"id": "Url",
- "description": "A person's associated URLs."
+ "description": "A person's associated URLs.",
+ "type": "object"
},
"ImClient": {
+ "description": "A person's instant messaging client.",
"type": "object",
"properties": {
"formattedProtocol": {
@@ -1825,8 +1932,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`",
@@ -1841,154 +1948,47 @@
"type": "string"
}
},
- "id": "ImClient",
- "description": "A person's instant messaging client."
- },
- "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"
- },
- "Membership": {
- "description": "A person's read-only membership in a group.",
- "type": "object",
- "properties": {
- "contactGroupMembership": {
- "$ref": "ContactGroupMembership",
- "description": "The contact group membership."
- },
- "domainMembership": {
- "$ref": "DomainMembership",
- "description": "The domain membership."
- },
- "metadata": {
- "description": "Metadata about the membership.",
- "$ref": "FieldMetadata"
- }
- },
- "id": "Membership"
- },
- "BatchGetContactGroupsResponse": {
- "properties": {
- "responses": {
- "description": "The list of responses for each requested contact group resource.",
- "type": "array",
- "items": {
- "$ref": "ContactGroupResponse"
- }
- }
- },
- "id": "BatchGetContactGroupsResponse",
- "description": "The response to a batch get contact groups request.",
- "type": "object"
- },
- "RelationshipStatus": {
- "type": "object",
- "properties": {
- "formattedValue": {
- "description": "The read-only value of the relationship status translated and formatted in\nthe viewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the relationship status."
- },
- "value": {
- "description": "The relationship status. The value can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplicated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilUnion`",
- "type": "string"
- }
- },
- "id": "RelationshipStatus",
- "description": "A person's read-only relationship status."
- },
- "BraggingRights": {
- "description": "A person's bragging rights.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the bragging rights."
- },
- "value": {
- "description": "The bragging rights; for example, `climbed mount everest`.",
- "type": "string"
- }
- },
- "id": "BraggingRights"
- },
- "Organization": {
- "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the organization."
- },
- "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"
- },
- "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": {
- "description": "The start date when the person joined the organization.",
- "$ref": "Date"
- },
- "domain": {
- "description": "The domain name associated with the organization; for example, `google.com`.",
- "type": "string"
- },
- "department": {
- "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"
- },
- "jobDescription": {
- "description": "The person's job description at the organization.",
- "type": "string"
- },
- "endDate": {
- "$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.",
- "type": "string"
- },
- "name": {
- "description": "The name of the organization.",
- "type": "string"
- }
- },
- "id": "Organization"
+ "id": "ImClient"
}
},
"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": "People Service",
+ "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"
+ },
+ "https://www.googleapis.com/auth/contacts": {
+ "description": "Manage your contacts"
+ },
+ "https://www.googleapis.com/auth/user.addresses.read": {
+ "description": "View your street addresses"
+ },
+ "https://www.googleapis.com/auth/user.phonenumbers.read": {
+ "description": "View your phone numbers"
+ },
+ "https://www.googleapis.com/auth/userinfo.email": {
+ "description": "View your email address"
+ },
+ "https://www.googleapis.com/auth/user.birthday.read": {
+ "description": "View your complete date of birth"
+ },
+ "https://www.googleapis.com/auth/contacts.readonly": {
+ "description": "View your contacts"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://people.googleapis.com/"
}
diff --git a/poly/v1/poly-api.json b/poly/v1/poly-api.json
index dc299d9..4a09a36 100644
--- a/poly/v1/poly-api.json
+++ b/poly/v1/poly-api.json
@@ -1,314 +1,119 @@
{
- "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": "",
- "id": "poly:v1",
- "documentationLink": "https://developers.google.com/poly/",
- "revision": "20171213",
- "discoveryVersion": "v1",
- "version_module": true,
- "schemas": {
- "File": {
- "description": "Represents a file in Poly, which can be a root,\nresource, or thumbnail file.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- },
- "ListLikedAssetsResponse": {
- "description": "A response message from a request to list.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The continuation token for retrieving the next page. If empty,\nindicates that there are no more pages. To get the next page, submit the\nsame request specifying this value as the\npage_token.",
- "type": "string"
- },
- "assets": {
- "description": "A list of assets that match the criteria specified in the request.",
- "type": "array",
- "items": {
- "$ref": "Asset"
- }
- },
- "totalSize": {
- "description": "The total number of assets in the list, without pagination.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ListLikedAssetsResponse"
- },
- "ListAssetsResponse": {
- "description": "A response message from a request to list.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The continuation token for retrieving the next page. If empty,\nindicates that there are no more pages. To get the next page, submit the\nsame request specifying this value as the\npage_token.",
- "type": "string"
- },
- "assets": {
- "description": "A list of assets that match the criteria specified in the request.",
- "type": "array",
- "items": {
- "$ref": "Asset"
- }
- },
- "totalSize": {
- "description": "The total number of assets in the list, without pagination.",
- "format": "int32",
- "type": "integer"
- }
- },
- "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": {
- "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"
- },
- "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"
- ]
- },
- "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"
- },
- "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"
- }
- },
- "id": "Asset"
- },
- "PresentationParams": {
- "description": "Hints for displaying the asset, based on information available when the asset\nwas uploaded.",
- "type": "object",
- "properties": {
- "colorSpace": {
- "enumDescriptions": [
- "Invalid color value.",
- "Linear color values. Default.",
- "Colors should be converted to linear by assuming gamma = 2.0."
- ],
- "enum": [
- "UNKNOWN",
- "LINEAR",
- "GAMMA"
- ],
- "description": "The materials' diffuse/albedo color. This does not apply to vertex colors\nor texture maps.",
- "type": "string"
- },
- "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."
- }
- },
- "id": "PresentationParams"
- },
- "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",
- "properties": {
- "y": {
- "description": "The y component.",
- "format": "double",
- "type": "number"
- },
- "x": {
- "description": "The x component.",
- "format": "double",
- "type": "number"
- },
- "z": {
- "description": "The z component.",
- "format": "double",
- "type": "number"
- },
- "w": {
- "description": "The scalar component.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Quaternion"
- },
- "FormatComplexity": {
- "description": "Information on the complexity of this Format.",
- "type": "object",
- "properties": {
- "lodHint": {
- "description": "A non-negative integer that represents the level of detail (LOD) of this\nformat relative to other formats of the same asset with the same\nformat_type.\nThis hint allows you to sort formats from the most-detailed (0) to\nleast-detailed (integers greater than 0).",
- "format": "int32",
- "type": "integer"
- },
- "triangleCount": {
- "description": "The estimated number of triangles.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "FormatComplexity"
- },
- "ListUserAssetsResponse": {
- "description": "A response message from a request to list.",
- "type": "object",
- "properties": {
- "userAssets": {
- "description": "A list of UserAssets matching the request.",
- "type": "array",
- "items": {
- "$ref": "UserAsset"
- }
- },
- "nextPageToken": {
- "description": "The continuation token for retrieving the next page. If empty,\nindicates that there are no more pages. To get the next page, submit the\nsame request specifying this value as the\npage_token.",
- "type": "string"
- },
- "totalSize": {
- "description": "The total number of assets in the list, without pagination.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ListUserAssetsResponse"
- },
- "UserAsset": {
- "description": "Data about the user's asset.",
- "type": "object",
- "properties": {
- "asset": {
- "description": "An Asset.",
- "$ref": "Asset"
- }
- },
- "id": "UserAsset"
- }
- },
- "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": "Poly Service",
- "rootUrl": "https://poly.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "poly",
- "batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Poly API",
"ownerName": "Google",
"resources": {
+ "users": {
+ "resources": {
+ "likedassets": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListLikedAssetsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^users/[^/]+$",
+ "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"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`, 'LIKED_TIME'. Defaults to `LIKED_TIME`, which\nranks assets based on how recently they were liked.",
+ "type": "string"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "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\nnext_page_token."
+ },
+ "pageSize": {
+ "description": "The maximum number of assets to be returned. This value must be between `1`\nand `100`. Defaults to `20`.",
+ "format": "int32",
+ "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"
+ }
+ },
+ "flatPath": "v1/users/{usersId}/likedassets",
+ "path": "v1/{+name}/likedassets",
+ "id": "poly.users.likedassets.list",
+ "description": "Lists assets that the user has liked. Only the value 'me', representing\nthe currently-authenticated user, is supported. May include assets with an\naccess level of UNLISTED."
+ }
+ }
+ },
+ "assets": {
+ "methods": {
+ "list": {
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^users/[^/]+$",
+ "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."
+ },
+ "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`.",
+ "type": "string"
+ },
+ "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\nnext_page_token.",
+ "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"
+ },
+ "visibility": {
+ "description": "The visibility of the assets to be returned.\nDefaults to VISIBILITY_UNSPECIFIED which returns all assets.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "VISIBILITY_UNSPECIFIED",
+ "PUBLISHED",
+ "PRIVATE"
+ ]
+ }
+ },
+ "flatPath": "v1/users/{usersId}/assets",
+ "id": "poly.users.assets.list",
+ "path": "v1/{+name}/assets",
+ "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.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListUserAssetsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ]
+ }
+ }
+ }
+ }
+ },
"assets": {
"methods": {
"get": {
- "flatPath": "v1/assets/{assetsId}",
- "id": "poly.assets.get",
- "path": "v1/{+name}",
- "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.",
"httpMethod": "GET",
"parameterOrder": [
"name"
@@ -318,37 +123,25 @@
},
"parameters": {
"name": {
- "location": "path",
"description": "Required. An asset's name in the form `assets/{ASSET_ID}`.",
"required": true,
"type": "string",
- "pattern": "^assets/[^/]+$"
+ "pattern": "^assets/[^/]+$",
+ "location": "path"
}
- }
+ },
+ "flatPath": "v1/assets/{assetsId}",
+ "id": "poly.assets.get",
+ "path": "v1/{+name}",
+ "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."
},
"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": {
- "format": {
- "location": "query",
- "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.",
- "type": "string"
- },
- "curated": {
- "location": "query",
- "description": "Return only assets that have been curated by the Poly team.",
- "type": "boolean"
- },
- "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"
- },
"maxComplexity": {
"location": "query",
"enum": [
@@ -366,10 +159,10 @@
"type": "string"
},
"pageSize": {
- "description": "The maximum number of assets to be returned. This value must be between `1`\nand `100`. Defaults to `20`.",
- "format": "int32",
"type": "integer",
- "location": "query"
+ "location": "query",
+ "description": "The maximum number of assets to be returned. This value must be between `1`\nand `100`. Defaults to `20`.",
+ "format": "int32"
},
"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.",
@@ -377,131 +170,39 @@
"location": "query"
},
"orderBy": {
+ "type": "string",
"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.",
+ "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."
+ },
+ "format": {
+ "location": "query",
+ "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.",
+ "type": "string"
+ },
+ "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"
}
},
"flatPath": "v1/assets",
"path": "v1/assets",
- "id": "poly.assets.list"
- }
- }
- },
- "users": {
- "resources": {
- "likedassets": {
- "methods": {
- "list": {
- "flatPath": "v1/users/{usersId}/likedassets",
- "path": "v1/{+name}/likedassets",
- "id": "poly.users.likedassets.list",
- "description": "Lists assets that the user has liked. Only the value 'me', representing\nthe currently-authenticated user, is supported. May include assets with an\naccess level of UNLISTED.",
- "response": {
- "$ref": "ListLikedAssetsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "format": {
- "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.",
- "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`, 'LIKED_TIME'. Defaults to `LIKED_TIME`, which\nranks assets based on how recently they were liked.",
- "type": "string"
- },
- "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\nnext_page_token.",
- "type": "string",
- "location": "query"
- }
- }
- }
- }
- },
- "assets": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListUserAssetsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "format": {
- "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "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\nnext_page_token.",
- "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"
- },
- "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": {
- "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"
- }
- },
- "flatPath": "v1/users/{usersId}/assets",
- "id": "poly.users.assets.list",
- "path": "v1/{+name}/assets",
- "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."
- }
- }
+ "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": {
- "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",
@@ -564,9 +265,9 @@
"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.",
@@ -575,14 +276,313 @@
"location": "query"
},
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
}
- }
+ },
+ "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": "",
+ "id": "poly:v1",
+ "documentationLink": "https://developers.google.com/poly/",
+ "revision": "20171213",
+ "discoveryVersion": "v1",
+ "version_module": true,
+ "schemas": {
+ "ListAssetsResponse": {
+ "description": "A response message from a request to list.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The continuation token for retrieving the next page. If empty,\nindicates that there are no more pages. To get the next page, submit the\nsame request specifying this value as the\npage_token.",
+ "type": "string"
+ },
+ "assets": {
+ "description": "A list of assets that match the criteria specified in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Asset"
+ }
+ },
+ "totalSize": {
+ "description": "The total number of assets in the list, without pagination.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "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": {
+ "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": {
+ "$ref": "FormatComplexity",
+ "description": "Complexity stats about this representation of the asset."
+ },
+ "root": {
+ "$ref": "File",
+ "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."
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ },
+ "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": {
+ "$ref": "PresentationParams",
+ "description": "Hints for displaying the asset. Note that these parameters are not\nimmutable; the author of an asset may change them post-publication."
+ },
+ "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": {
+ "enum": [
+ "VISIBILITY_UNSPECIFIED",
+ "PRIVATE",
+ "UNLISTED",
+ "PUBLIC"
+ ],
+ "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."
+ ]
+ },
+ "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",
+ "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": {
+ "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."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "LINEAR",
+ "GAMMA"
+ ]
+ }
+ },
+ "id": "PresentationParams"
+ },
+ "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",
+ "properties": {
+ "y": {
+ "type": "number",
+ "description": "The y component.",
+ "format": "double"
+ },
+ "x": {
+ "description": "The x component.",
+ "format": "double",
+ "type": "number"
+ },
+ "z": {
+ "description": "The z component.",
+ "format": "double",
+ "type": "number"
+ },
+ "w": {
+ "description": "The scalar component.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "Quaternion"
+ },
+ "FormatComplexity": {
+ "properties": {
+ "lodHint": {
+ "description": "A non-negative integer that represents the level of detail (LOD) of this\nformat relative to other formats of the same asset with the same\nformat_type.\nThis hint allows you to sort formats from the most-detailed (0) to\nleast-detailed (integers greater than 0).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "triangleCount": {
+ "type": "string",
+ "description": "The estimated number of triangles.",
+ "format": "int64"
+ }
+ },
+ "id": "FormatComplexity",
+ "description": "Information on the complexity of this Format.",
+ "type": "object"
+ },
+ "ListUserAssetsResponse": {
+ "description": "A response message from a request to list.",
+ "type": "object",
+ "properties": {
+ "userAssets": {
+ "description": "A list of UserAssets matching the request.",
+ "type": "array",
+ "items": {
+ "$ref": "UserAsset"
+ }
+ },
+ "nextPageToken": {
+ "description": "The continuation token for retrieving the next page. If empty,\nindicates that there are no more pages. To get the next page, submit the\nsame request specifying this value as the\npage_token.",
+ "type": "string"
+ },
+ "totalSize": {
+ "description": "The total number of assets in the list, without pagination.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ListUserAssetsResponse"
+ },
+ "UserAsset": {
+ "description": "Data about the user's asset.",
+ "type": "object",
+ "properties": {
+ "asset": {
+ "description": "An Asset.",
+ "$ref": "Asset"
+ }
+ },
+ "id": "UserAsset"
+ },
+ "File": {
+ "description": "Represents a file in Poly, which can be a root,\nresource, or thumbnail file.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ },
+ "ListLikedAssetsResponse": {
+ "description": "A response message from a request to list.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "The continuation token for retrieving the next page. If empty,\nindicates that there are no more pages. To get the next page, submit the\nsame request specifying this value as the\npage_token."
+ },
+ "assets": {
+ "description": "A list of assets that match the criteria specified in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Asset"
+ }
+ },
+ "totalSize": {
+ "description": "The total number of assets in the list, without pagination.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ListLikedAssetsResponse"
+ }
+ },
+ "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": "Poly Service",
+ "rootUrl": "https://poly.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "poly",
+ "batchPath": "batch"
}
diff --git a/proximitybeacon/v1beta1/proximitybeacon-api.json b/proximitybeacon/v1beta1/proximitybeacon-api.json
index 509a770..abe73fc 100644
--- a/proximitybeacon/v1beta1/proximitybeacon-api.json
+++ b/proximitybeacon/v1beta1/proximitybeacon-api.json
@@ -1,53 +1,27 @@
{
- "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",
- "id": "proximitybeacon:v1beta1",
- "documentationLink": "https://developers.google.com/beacons/proximity/",
- "revision": "20171112",
- "title": "Google Proximity Beacon API",
- "ownerName": "Google",
- "discoveryVersion": "v1",
- "version_module": true,
"resources": {
"beaconinfo": {
"methods": {
"getforobserved": {
+ "id": "proximitybeacon.beaconinfo.getforobserved",
+ "path": "v1beta1/beaconinfo:getforobserved",
"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.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "GetInfoForObservedBeaconsResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
"parameters": {},
- "flatPath": "v1beta1/beaconinfo:getforobserved",
- "path": "v1beta1/beaconinfo:getforobserved",
- "id": "proximitybeacon.beaconinfo.getforobserved"
+ "flatPath": "v1beta1/beaconinfo:getforobserved"
}
}
},
"namespaces": {
"methods": {
"list": {
- "description": "Lists all attachment namespaces owned by your Google Developers Console\nproject. Attachment data associated with a beacon must include a\nnamespaced type, and the namespace must be owned by your project.\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": "ListNamespacesResponse"
},
@@ -65,7 +39,8 @@
},
"flatPath": "v1beta1/namespaces",
"path": "v1beta1/namespaces",
- "id": "proximitybeacon.namespaces.list"
+ "id": "proximitybeacon.namespaces.list",
+ "description": "Lists all attachment namespaces owned by your Google Developers Console\nproject. Attachment data associated with a beacon must include a\nnamespaced type, and the namespace must be owned by your project.\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."
},
"update": {
"description": "Updates the information about the specified namespace. Only the namespace\nvisibility can be updated.",
@@ -105,102 +80,46 @@
"v1beta1": {
"methods": {
"getEidparams": {
- "flatPath": "v1beta1/eidparams",
- "path": "v1beta1/eidparams",
"id": "proximitybeacon.getEidparams",
+ "path": "v1beta1/eidparams",
"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",
+ "parameterOrder": [],
"response": {
"$ref": "EphemeralIdRegistrationParams"
},
- "parameterOrder": [],
- "httpMethod": "GET",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
+ ],
+ "flatPath": "v1beta1/eidparams"
}
}
},
"beacons": {
"methods": {
- "activate": {
- "flatPath": "v1beta1/beacons/{beaconsId}:activate",
- "path": "v1beta1/{+beaconName}:activate",
- "id": "proximitybeacon.beacons.activate",
- "description": "Activates a beacon. A beacon that is active will return information\nand attachment data when queried via `beaconinfo.getforobserved`.\nCalling this method on an already active beacon will do nothing (but\nwill 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 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": {
- "location": "path",
- "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/[^/]+$"
- }
- }
- },
- "get": {
- "description": "Returns detailed information about the specified beacon.\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.\n\nRequests may supply an Eddystone-EID beacon name in the form:\n`beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID\nbroadcast by the beacon. The returned `Beacon` object will contain the\nbeacon's stable Eddystone-UID. Clients not authorized to resolve the\nbeacon's ephemeral Eddystone-EID broadcast will receive an error.",
- "response": {
- "$ref": "Beacon"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "GET",
- "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": {
- "location": "query",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "flatPath": "v1beta1/beacons/{beaconsId}",
- "path": "v1beta1/{+beaconName}",
- "id": "proximitybeacon.beacons.get"
- },
"update": {
- "response": {
+ "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"
],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
+ "response": {
+ "$ref": "Beacon"
+ },
"parameters": {
"beaconName": {
+ "pattern": "^beacons/[^/]+$",
+ "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/[^/]+$",
- "location": "path"
+ "type": "string"
},
"projectId": {
"location": "query",
@@ -208,16 +127,11 @@
"type": "string"
}
},
- "flatPath": "v1beta1/beacons/{beaconsId}",
- "path": "v1beta1/{+beaconName}",
- "id": "proximitybeacon.beacons.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"
- }
+ "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.",
@@ -235,21 +149,19 @@
"type": "string"
},
"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/[^/]+$"
+ "pattern": "^beacons/[^/]+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}:decommission"
},
"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"
@@ -258,23 +170,26 @@
"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/[^/]+$"
+ "pattern": "^beacons/[^/]+$",
+ "location": "path"
+ },
+ "projectId": {
+ "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}:deactivate",
+ "path": "v1beta1/{+beaconName}:deactivate",
+ "id": "proximitybeacon.beacons.deactivate"
},
"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.",
@@ -307,7 +222,6 @@
"id": "proximitybeacon.beacons.delete"
},
"list": {
- "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"
},
@@ -318,32 +232,36 @@
],
"parameters": {
"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",
- "location": "query"
+ "type": "string"
},
"pageSize": {
+ "location": "query",
"description": "The maximum number of records to return for this request, up to a\nserver-defined upper limit.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "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"
+ "type": "string"
},
"pageToken": {
- "location": "query",
"description": "A pagination token obtained from a previous request to list beacons.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"flatPath": "v1beta1/beacons",
"path": "v1beta1/beacons",
- "id": "proximitybeacon.beacons.list"
+ "id": "proximitybeacon.beacons.list",
+ "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."
},
"register": {
+ "flatPath": "v1beta1/beacons:register",
+ "path": "v1beta1/beacons:register",
+ "id": "proximitybeacon.beacons.register",
"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.",
"request": {
"$ref": "Beacon"
@@ -362,10 +280,67 @@
"description": "The project id of the project the beacon will be registered to. If\nthe project id is not specified then the project making the request\nis used.\nOptional.",
"type": "string"
}
+ }
+ },
+ "activate": {
+ "response": {
+ "$ref": "Empty"
},
- "flatPath": "v1beta1/beacons:register",
- "path": "v1beta1/beacons:register",
- "id": "proximitybeacon.beacons.register"
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}:activate",
+ "path": "v1beta1/{+beaconName}:activate",
+ "id": "proximitybeacon.beacons.activate",
+ "description": "Activates a beacon. A beacon that is active will return information\nand attachment data when queried via `beaconinfo.getforobserved`.\nCalling this method on an already active beacon will do nothing (but\nwill 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."
+ },
+ "get": {
+ "description": "Returns detailed information about the specified beacon.\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.\n\nRequests may supply an Eddystone-EID beacon name in the form:\n`beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID\nbroadcast by the beacon. The returned `Beacon` object will contain the\nbeacon's stable Eddystone-UID. Clients not authorized to resolve the\nbeacon's ephemeral Eddystone-EID broadcast will receive an error.",
+ "response": {
+ "$ref": "Beacon"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "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"
+ },
+ "beaconName": {
+ "pattern": "^beacons/[^/]+$",
+ "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-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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "flatPath": "v1beta1/beacons/{beaconsId}",
+ "path": "v1beta1/{+beaconName}",
+ "id": "proximitybeacon.beacons.get"
}
},
"resources": {
@@ -380,19 +355,10 @@
"beaconName"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
"parameters": {
- "beaconName": {
- "location": "path",
- "description": "Beacon that the diagnostics are for.",
- "required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+$"
- },
- "pageToken": {
- "location": "query",
- "description": "Requests results that occur after the `page_token`, obtained from the\nresponse to a previous request. Optional.",
- "type": "string"
- },
"pageSize": {
"description": "Specifies the maximum number of results to return. Defaults to\n10. Maximum 1000. Optional.",
"format": "int32",
@@ -400,25 +366,34 @@
"location": "query"
},
"alertFilter": {
- "description": "Requests only beacons that have the given alert. For example, to find\nbeacons that have low batteries use `alert_filter=LOW_BATTERY`.",
- "type": "string",
"location": "query",
"enum": [
"ALERT_UNSPECIFIED",
"WRONG_LOCATION",
"LOW_BATTERY",
"LOW_ACTIVITY"
- ]
+ ],
+ "description": "Requests only beacons that have the given alert. For example, to find\nbeacons that have low batteries use `alert_filter=LOW_BATTERY`.",
+ "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"
+ },
+ "beaconName": {
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
+ "description": "Beacon that the diagnostics are for.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Requests results that occur after the `page_token`, obtained from the\nresponse to a previous request. Optional.",
"type": "string",
"location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
"flatPath": "v1beta1/beacons/{beaconsId}/diagnostics",
"path": "v1beta1/{+beaconName}/diagnostics",
"id": "proximitybeacon.beacons.diagnostics.list"
@@ -427,110 +402,10 @@
},
"attachments": {
"methods": {
- "list": {
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
- "id": "proximitybeacon.beacons.attachments.list",
- "path": "v1beta1/{+beaconName}/attachments",
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "beaconName"
- ],
- "response": {
- "$ref": "ListBeaconAttachmentsResponse"
- },
- "parameters": {
- "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\".",
- "type": "string",
- "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/[^/]+$"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- },
- "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.",
- "request": {
- "$ref": "BeaconAttachment"
- },
- "response": {
- "$ref": "BeaconAttachment"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ],
- "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/[^/]+$"
- }
- },
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
- "path": "v1beta1/{+beaconName}/attachments",
- "id": "proximitybeacon.beacons.attachments.create"
- },
- "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"
- },
- "parameterOrder": [
- "beaconName"
- ],
- "httpMethod": "POST",
- "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"
- },
- "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"
- },
- "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.",
- "required": true,
- "type": "string",
- "pattern": "^beacons/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- },
"delete": {
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments/{attachmentsId}",
+ "path": "v1beta1/{+attachmentName}",
+ "id": "proximitybeacon.beacons.attachments.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.",
"response": {
"$ref": "Empty"
@@ -539,26 +414,126 @@
"attachmentName"
],
"httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
"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"
+ }
+ }
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListBeaconAttachmentsResponse"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "parameters": {
+ "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\".",
+ "type": "string",
+ "location": "query"
+ },
+ "beaconName": {
+ "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/[^/]+$",
+ "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"
+ "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"
}
},
"scopes": [
"https://www.googleapis.com/auth/userlocation.beacon.registry"
],
- "flatPath": "v1beta1/beacons/{beaconsId}/attachments/{attachmentsId}",
- "path": "v1beta1/{+attachmentName}",
- "id": "proximitybeacon.beacons.attachments.delete"
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
+ "id": "proximitybeacon.beacons.attachments.list",
+ "path": "v1beta1/{+beaconName}/attachments",
+ "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": {
+ "response": {
+ "$ref": "BeaconAttachment"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "parameters": {
+ "beaconName": {
+ "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/[^/]+$",
+ "location": "path"
+ },
+ "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"
+ }
+ },
+ "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.",
+ "request": {
+ "$ref": "BeaconAttachment"
+ }
+ },
+ "batchDelete": {
+ "response": {
+ "$ref": "DeleteAttachmentsResponse"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "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.",
+ "required": true,
+ "type": "string",
+ "pattern": "^beacons/[^/]+$",
+ "location": "path"
+ },
+ "projectId": {
+ "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"
+ },
+ "namespacedType": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ],
+ "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."
}
}
}
@@ -566,49 +541,14 @@
}
},
"parameters": {
- "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": {
- "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": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -617,13 +557,9 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
+ ]
},
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -635,149 +571,68 @@
"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": {
+ "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": {
"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"
+ },
+ "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"
}
},
"schemas": {
- "ListBeaconAttachmentsResponse": {
- "description": "Response to `ListBeaconAttachments` that contains the requested attachments.",
- "type": "object",
- "properties": {
- "attachments": {
- "description": "The attachments that corresponded to the request params.",
- "type": "array",
- "items": {
- "$ref": "BeaconAttachment"
- }
- }
- },
- "id": "ListBeaconAttachmentsResponse"
- },
- "Namespace": {
- "description": "An attachment namespace defines read and write access for all the attachments\ncreated under it. Each namespace is globally unique, and owned by one\nproject which is the only project that can create attachments under it.",
- "type": "object",
- "properties": {
- "namespaceName": {
- "description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.",
- "type": "string"
- },
- "servingVisibility": {
- "enumDescriptions": [
- "Do not use this value.",
- "Served only to the project that owns the namespace.",
- "Any project can subscribe to attachments under the namespace."
- ],
- "enum": [
- "VISIBILITY_UNSPECIFIED",
- "UNLISTED",
- "PUBLIC"
- ],
- "description": "Specifies what clients may receive attachments under this namespace\nvia `beaconinfo.getforobserved`.",
- "type": "string"
- }
- },
- "id": "Namespace"
- },
- "AttachmentInfo": {
- "description": "A subset of attachment information served via the\n`beaconinfo.getforobserved` method, used when your users encounter your\nbeacons.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- }
- },
- "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": {
- "description": "The ID advertised by the beacon.",
- "$ref": "AdvertisedId"
- },
- "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": {
- "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"
- },
- "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"
- }
- },
- "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": {
- "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"
- },
"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",
@@ -787,6 +642,10 @@
"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"
@@ -827,28 +686,11 @@
"description": "Details of a beacon device.",
"type": "object",
"properties": {
- "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."
- },
- "description": {
- "description": "Free text used to identify and describe the beacon. Maximum length 140\ncharacters.\nOptional.",
- "type": "string"
- },
- "placeId": {
- "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"
- },
- "properties": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Properties of the beacon device, for example battery type or firmware\nversion.\nOptional.",
- "type": "object"
+ "indoorLevel": {
+ "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional.",
+ "$ref": "IndoorLevel"
},
"status": {
- "description": "Current status of the beacon.\nRequired.",
- "type": "string",
"enumDescriptions": [
"Do not use this value.",
"The \"normal\" in-use state of a beacon.",
@@ -860,11 +702,9 @@
"ACTIVE",
"DECOMMISSIONED",
"INACTIVE"
- ]
- },
- "indoorLevel": {
- "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional.",
- "$ref": "IndoorLevel"
+ ],
+ "description": "Current status of the beacon.\nRequired.",
+ "type": "string"
},
"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.",
@@ -892,25 +732,40 @@
"$ref": "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."
},
+ "ephemeralIdRegistration": {
+ "$ref": "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."
+ },
"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"
+ },
+ "placeId": {
+ "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"
+ },
+ "description": {
+ "description": "Free text used to identify and describe the beacon. Maximum length 140\ncharacters.\nOptional.",
+ "type": "string"
+ },
+ "properties": {
+ "description": "Properties of the beacon device, for example battery type or firmware\nversion.\nOptional.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
}
},
"id": "Beacon"
},
"AdvertisedId": {
- "description": "Defines a unique identifier of a beacon as broadcast by the device.",
- "type": "object",
"properties": {
"type": {
- "description": "Specifies the identifier type.\nRequired.",
- "type": "string",
"enumDescriptions": [
"Do not use this value.",
"Eddystone, an open beacon format that supports Android and iOS devices\nhttps://github.com/google/eddystone/wiki/Beacon-Specification",
@@ -924,7 +779,9 @@
"IBEACON",
"ALTBEACON",
"EDDYSTONE_EID"
- ]
+ ],
+ "description": "Specifies the identifier type.\nRequired.",
+ "type": "string"
},
"id": {
"description": "The actual beacon identifier, as broadcast by the beacon hardware. 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. The base64\nencoding should be of the binary byte-stream and not any textual (such as\nhex) representation thereof.\nRequired.",
@@ -932,18 +789,9 @@
"type": "string"
}
},
- "id": "AdvertisedId"
- },
- "IndoorLevel": {
- "description": "Indoor level, a human-readable string as returned by Google Maps APIs,\nuseful to indicate which floor of a building a beacon is located on.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of this level.",
- "type": "string"
- }
- },
- "id": "IndoorLevel"
+ "id": "AdvertisedId",
+ "description": "Defines a unique identifier of a beacon as broadcast by the device.",
+ "type": "object"
},
"Date": {
"description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
@@ -967,6 +815,17 @@
},
"id": "Date"
},
+ "IndoorLevel": {
+ "description": "Indoor level, a human-readable string as returned by Google Maps APIs,\nuseful to indicate which floor of a building a beacon is located on.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of this level.",
+ "type": "string"
+ }
+ },
+ "id": "IndoorLevel"
+ },
"ListNamespacesResponse": {
"description": "Response to ListNamespacesRequest that contains all the project's namespaces.",
"type": "object",
@@ -1005,44 +864,44 @@
"id": "ListBeaconsResponse"
},
"Diagnostics": {
- "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": {
- "description": "An unordered list of Alerts that the beacon has.",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "ALERT_UNSPECIFIED",
- "WRONG_LOCATION",
- "LOW_BATTERY",
- "LOW_ACTIVITY"
- ]
- },
"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": {
+ "enum": [
+ "ALERT_UNSPECIFIED",
+ "WRONG_LOCATION",
+ "LOW_BATTERY",
+ "LOW_ACTIVITY"
+ ],
+ "type": "string"
+ }
},
"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."
}
},
- "id": "Diagnostics"
+ "id": "Diagnostics",
+ "description": "Diagnostics for a single beacon.",
+ "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"
+ "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"
},
"GetInfoForObservedBeaconsRequest": {
"description": "Request for beacon and attachment information about beacons that\na mobile client has encountered \"in the wild\".",
@@ -1069,14 +928,6 @@
"description": "Project-specific data associated with a beacon.",
"type": "object",
"properties": {
- "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"
- },
- "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. Namespace\nprovides type separation between clients. Type describes the type of\n`data`, for use by the client when parsing the `data` field.\nRequired.",
- "type": "string"
- },
"data": {
"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",
@@ -1091,6 +942,14 @@
"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"
+ },
+ "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. Namespace\nprovides type separation between clients. Type describes the type of\n`data`, for use by the client when parsing the `data` field.\nRequired.",
+ "type": "string"
}
},
"id": "BeaconAttachment"
@@ -1099,6 +958,21 @@
"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": {
+ "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"
+ },
+ "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",
@@ -1113,21 +987,6 @@
"description": "An initial ephemeral ID calculated using the clock value submitted as\n`initial_clock_value`, and the secret key generated by the\nDiffie-Hellman key exchange using `service_ecdh_public_key` and\n`service_ecdh_public_key`. This initial EID value will be used by the\nservice to confirm that the key exchange process was successful.",
"format": "byte",
"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"
@@ -1148,12 +1007,153 @@
}
},
"id": "LatLng"
+ },
+ "ListBeaconAttachmentsResponse": {
+ "description": "Response to `ListBeaconAttachments` that contains the requested attachments.",
+ "type": "object",
+ "properties": {
+ "attachments": {
+ "description": "The attachments that corresponded to the request params.",
+ "type": "array",
+ "items": {
+ "$ref": "BeaconAttachment"
+ }
+ }
+ },
+ "id": "ListBeaconAttachmentsResponse"
+ },
+ "Namespace": {
+ "description": "An attachment namespace defines read and write access for all the attachments\ncreated under it. Each namespace is globally unique, and owned by one\nproject which is the only project that can create attachments under it.",
+ "type": "object",
+ "properties": {
+ "servingVisibility": {
+ "enum": [
+ "VISIBILITY_UNSPECIFIED",
+ "UNLISTED",
+ "PUBLIC"
+ ],
+ "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.",
+ "Any project can subscribe to attachments under the namespace."
+ ]
+ },
+ "namespaceName": {
+ "description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.",
+ "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": {
+ "beaconName": {
+ "description": "The name under which the beacon is registered.",
+ "type": "string"
+ },
+ "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"
+ }
+ }
+ },
+ "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"
}
},
+ "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": "v1beta1"
+ "version": "v1beta1",
+ "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",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
+ "version_module": true
}
diff --git a/pubsub/v1/pubsub-api.json b/pubsub/v1/pubsub-api.json
index 0b7944e..2db7816 100644
--- a/pubsub/v1/pubsub-api.json
+++ b/pubsub/v1/pubsub-api.json
@@ -1,316 +1,28 @@
{
+ "rootUrl": "https://pubsub.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "pubsub",
+ "batchPath": "batch",
+ "revision": "20171205",
+ "documentationLink": "https://cloud.google.com/pubsub/docs",
+ "id": "pubsub:v1",
+ "title": "Google Cloud Pub/Sub API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"projects": {
"resources": {
"subscriptions": {
"methods": {
- "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/[^/]+/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": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "pubsub.projects.subscriptions.setIamPolicy"
- },
- "getIamPolicy": {
- "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.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
- "path": "v1/{+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."
- },
- "modifyAckDeadline": {
- "httpMethod": "POST",
- "parameterOrder": [
- "subscription"
- ],
- "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"
- }
- },
- "scopes": [
- "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."
- },
- "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"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "parameters": {
- "subscription": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:pull"
- },
- "list": {
- "response": {
- "$ref": "ListSubscriptionsResponse"
- },
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "pageToken": {
- "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",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of subscriptions to return.",
- "format": "int32",
- "type": "integer"
- },
- "project": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The name of the cloud project that subscriptions belong to.\nFormat is `projects/{project}`."
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions",
- "path": "v1/{+project}/subscriptions",
- "id": "pubsub.projects.subscriptions.list",
- "description": "Lists matching 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"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "name": {
- "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",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}"
- },
- "acknowledge": {
- "httpMethod": "POST",
- "parameterOrder": [
- "subscription"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "subscription": {
- "location": "path",
- "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge",
- "id": "pubsub.projects.subscriptions.acknowledge",
- "path": "v1/{+subscription}: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."
- },
- "patch": {
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "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": "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."
- },
- "get": {
- "path": "v1/{+subscription}",
- "id": "pubsub.projects.subscriptions.get",
- "description": "Gets the configuration details of a subscription.",
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "GET",
- "parameters": {
- "subscription": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}"
- },
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "required": true,
- "type": "string",
- "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."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "pubsub.projects.subscriptions.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."
- },
"seek": {
- "httpMethod": "POST",
- "parameterOrder": [
- "subscription"
- ],
- "response": {
- "$ref": "SeekResponse"
- },
"parameters": {
"subscription": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"location": "path",
"description": "The subscription to affect.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ "type": "string"
}
},
"scopes": [
@@ -323,15 +35,16 @@
"request": {
"$ref": "SeekRequest"
},
- "description": "Seeks an existing subscription to a point in time or to a given snapshot,\nwhichever is provided in the request."
+ "description": "Seeks an existing subscription to a point in time or to a given snapshot,\nwhichever is provided in the request.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "SeekResponse"
+ }
},
"modifyPushConfig": {
- "path": "v1/{+subscription}:modifyPushConfig",
- "id": "pubsub.projects.subscriptions.modifyPushConfig",
- "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`.",
"response": {
"$ref": "Empty"
},
@@ -339,27 +52,117 @@
"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.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`."
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}: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"
+ }
+ },
+ "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"
+ ],
+ "parameters": {
+ "subscription": {
+ "location": "path",
+ "description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig"
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}"
},
- "delete": {
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "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",
+ "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/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "pubsub.projects.subscriptions.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ },
+ "getIamPolicy": {
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
+ "path": "v1/{+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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "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/[^/]+/subscriptions/[^/]+$"
+ }
+ }
+ },
+ "modifyAckDeadline": {
+ "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.",
+ "httpMethod": "POST",
"parameterOrder": [
"subscription"
],
@@ -368,7 +171,95 @@
},
"parameters": {
"subscription": {
- "description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "location": "path",
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "pull": {
+ "path": "v1/{+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": {
+ "location": "path",
+ "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:pull"
+ },
+ "list": {
+ "description": "Lists matching subscriptions.",
+ "response": {
+ "$ref": "ListSubscriptionsResponse"
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "GET",
+ "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"
+ },
+ "pageSize": {
+ "description": "Maximum number of subscriptions to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "description": "The name of the cloud project that subscriptions belong to.\nFormat is `projects/{project}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions",
+ "path": "v1/{+project}/subscriptions",
+ "id": "pubsub.projects.subscriptions.list"
+ },
+ "create": {
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Subscription"
+ },
+ "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/[^/]+$",
@@ -378,16 +269,133 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "id": "pubsub.projects.subscriptions.create",
+ "path": "v1/{+name}",
+ "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",
+ "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"
+ }
+ },
+ "patch": {
+ "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.",
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "name": {
+ "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",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
]
+ },
+ "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."
+ },
+ "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/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
+ "id": "pubsub.projects.subscriptions.testIamPermissions",
+ "path": "v1/{+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."
}
}
},
"snapshots": {
"methods": {
"delete": {
- "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}",
- "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"
@@ -402,85 +410,59 @@
],
"parameters": {
"snapshot": {
- "location": "path",
- "description": "The name of the snapshot to delete.\nFormat is `projects/{project}/snapshots/{snap}`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/snapshots/[^/]+$"
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
+ "location": "path",
+ "description": "The name of the snapshot to delete.\nFormat is `projects/{project}/snapshots/{snap}`."
}
- }
+ },
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}",
+ "path": "v1/{+snapshot}",
+ "id": "pubsub.projects.snapshots.delete"
},
"list": {
"description": "Lists the existing snapshots.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListSnapshotsResponse"
},
"parameterOrder": [
"project"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
"parameters": {
+ "project": {
+ "location": "path",
+ "description": "The name of the cloud project that snapshots belong to.\nFormat is `projects/{project}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ },
"pageToken": {
+ "type": "string",
"location": "query",
- "description": "The value returned by the last `ListSnapshotsResponse`; indicates that this\nis a continuation of a prior `ListSnapshots` call, and that the system\nshould return the next page of data.",
- "type": "string"
+ "description": "The value returned by the last `ListSnapshotsResponse`; indicates that this\nis a continuation of a prior `ListSnapshots` call, and that the system\nshould return the next page of data."
},
"pageSize": {
"location": "query",
"description": "Maximum number of snapshots to return.",
"format": "int32",
"type": "integer"
- },
- "project": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The name of the cloud project that snapshots belong to.\nFormat is `projects/{project}`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/snapshots",
- "path": "v1/{+project}/snapshots",
- "id": "pubsub.projects.snapshots.list"
- },
- "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/[^/]+/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"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:setIamPolicy",
- "id": "pubsub.projects.snapshots.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy"
+ "flatPath": "v1/projects/{projectsId}/snapshots",
+ "id": "pubsub.projects.snapshots.list",
+ "path": "v1/{+project}/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"
},
@@ -488,77 +470,106 @@
"name"
],
"httpMethod": "PUT",
- "parameters": {
- "name": {
- "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",
- "pattern": "^projects/[^/]+/snapshots/[^/]+$"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "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}`."
+ }
+ },
"flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}",
"path": "v1/{+name}",
"id": "pubsub.projects.snapshots.create"
},
- "getIamPolicy": {
- "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",
- "parameterOrder": [
- "resource"
- ],
+ "setIamPolicy": {
"response": {
"$ref": "Policy"
},
- "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"
- }
- },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
- ]
- },
- "patch": {
- "request": {
- "$ref": "UpdateSnapshotRequest"
- },
- "description": "Updates an existing snapshot. Note that certain properties of a\nsnapshot are not modifiable.",
- "response": {
- "$ref": "Snapshot"
- },
- "parameterOrder": [
- "name"
],
- "httpMethod": "PATCH",
"parameters": {
- "name": {
- "description": "The name of the snapshot.",
+ "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/[^/]+/snapshots/[^/]+$",
"location": "path"
}
},
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "pubsub.projects.snapshots.setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ }
+ },
+ "getIamPolicy": {
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "pubsub.projects.snapshots.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",
"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/[^/]+/snapshots/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "patch": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the snapshot.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$"
+ }
+ },
"flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}",
"path": "v1/{+name}",
- "id": "pubsub.projects.snapshots.patch"
+ "id": "pubsub.projects.snapshots.patch",
+ "description": "Updates an existing snapshot. Note that certain properties of a\nsnapshot are not modifiable.",
+ "request": {
+ "$ref": "UpdateSnapshotRequest"
+ },
+ "response": {
+ "$ref": "Snapshot"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH"
},
"testIamPermissions": {
"request": {
@@ -574,11 +585,11 @@
"httpMethod": "POST",
"parameters": {
"resource": {
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
"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/[^/]+/snapshots/[^/]+$"
+ "type": "string"
}
},
"scopes": [
@@ -593,193 +604,15 @@
},
"topics": {
"methods": {
- "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"
- ],
- "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/[^/]+/topics/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:testIamPermissions",
- "id": "pubsub.projects.topics.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "topic"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "topic": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "Name of the topic to delete.\nFormat is `projects/{project}/topics/{topic}`."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
- "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_`."
- },
- "list": {
- "flatPath": "v1/projects/{projectsId}/topics",
- "id": "pubsub.projects.topics.list",
- "path": "v1/{+project}/topics",
- "description": "Lists matching topics.",
- "httpMethod": "GET",
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "ListTopicsResponse"
- },
- "parameters": {
- "project": {
- "location": "path",
- "description": "The name of the cloud project that topics belong to.\nFormat is `projects/{project}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "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"
- },
- "pageSize": {
- "description": "Maximum number of topics to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
- },
- "create": {
- "description": "Creates the given topic with the given name.",
- "request": {
- "$ref": "Topic"
- },
- "response": {
- "$ref": "Topic"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "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\"`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
- "path": "v1/{+name}",
- "id": "pubsub.projects.topics.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/[^/]+/topics/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "pubsub.projects.topics.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": {
- "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": {
- "required": true,
- "type": "string",
- "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."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "pubsub.projects.topics.getIamPolicy"
- },
"get": {
- "path": "v1/{+topic}",
- "id": "pubsub.projects.topics.get",
"description": "Gets the configuration of a topic.",
- "response": {
- "$ref": "Topic"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"topic"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Topic"
+ },
"parameters": {
"topic": {
"description": "The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`.",
@@ -793,25 +626,85 @@
"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}",
+ "id": "pubsub.projects.topics.get",
+ "path": "v1/{+topic}"
},
"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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "topic"
- ],
"response": {
"$ref": "PublishResponse"
},
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "POST",
"parameters": {
"topic": {
+ "location": "path",
"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/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:publish",
+ "path": "v1/{+topic}:publish",
+ "id": "pubsub.projects.topics.publish"
+ },
+ "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/pubsub"
+ ],
+ "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/[^/]+/topics/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "pubsub.projects.topics.testIamPermissions"
+ },
+ "delete": {
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
+ "path": "v1/{+topic}",
+ "id": "pubsub.projects.topics.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_`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "topic": {
+ "description": "Name of the topic to delete.\nFormat is `projects/{project}/topics/{topic}`.",
+ "required": true,
+ "type": "string",
"pattern": "^projects/[^/]+/topics/[^/]+$",
"location": "path"
}
@@ -819,20 +712,134 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "list": {
+ "response": {
+ "$ref": "ListTopicsResponse"
+ },
+ "parameterOrder": [
+ "project"
],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:publish",
- "id": "pubsub.projects.topics.publish",
- "path": "v1/{+topic}:publish"
+ "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"
+ },
+ "pageSize": {
+ "description": "Maximum number of topics to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "description": "The name of the cloud project that topics belong to.\nFormat is `projects/{project}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "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."
+ },
+ "setIamPolicy": {
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
+ "id": "pubsub.projects.topics.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": {
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "create": {
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "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\"`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ }
+ },
+ "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/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}: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."
}
},
"resources": {
"subscriptions": {
"methods": {
"list": {
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}/subscriptions",
- "path": "v1/{+topic}/subscriptions",
- "id": "pubsub.projects.topics.subscriptions.list",
- "description": "Lists the names of the subscriptions on this topic.",
"response": {
"$ref": "ListTopicSubscriptionsResponse"
},
@@ -846,9 +853,9 @@
],
"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.",
"type": "string",
- "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."
+ "location": "query"
},
"pageSize": {
"description": "Maximum number of subscription names to return.",
@@ -857,45 +864,41 @@
"location": "query"
},
"topic": {
- "location": "path",
"description": "The name of the topic that subscriptions are attached to.\nFormat is `projects/{project}/topics/{topic}`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$"
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
}
- }
+ },
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}/subscriptions",
+ "path": "v1/{+topic}/subscriptions",
+ "id": "pubsub.projects.topics.subscriptions.list",
+ "description": "Lists the names of the subscriptions on this topic."
}
}
},
"snapshots": {
"methods": {
"list": {
- "description": "Lists the names of the snapshots on this topic.",
- "httpMethod": "GET",
- "parameterOrder": [
- "topic"
- ],
- "response": {
- "$ref": "ListTopicSnapshotsResponse"
- },
"parameters": {
- "topic": {
- "description": "The name of the topic that snapshots are attached to.\nFormat is `projects/{project}/topics/{topic}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- },
"pageToken": {
- "type": "string",
"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."
+ "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"
},
"pageSize": {
"description": "Maximum number of snapshot names to return.",
"format": "int32",
"type": "integer",
"location": "query"
+ },
+ "topic": {
+ "description": "The name of the topic that snapshots are attached to.\nFormat is `projects/{project}/topics/{topic}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -904,7 +907,15 @@
],
"flatPath": "v1/projects/{projectsId}/topics/{topicsId}/snapshots",
"id": "pubsub.projects.topics.snapshots.list",
- "path": "v1/{+topic}/snapshots"
+ "path": "v1/{+topic}/snapshots",
+ "description": "Lists the names of the snapshots on this topic.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "topic"
+ ],
+ "response": {
+ "$ref": "ListTopicSnapshotsResponse"
+ }
}
}
}
@@ -914,31 +925,47 @@
}
},
"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": {
+ "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",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "default": "true"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
},
"$.xgafv": {
"enumDescriptions": [
@@ -953,6 +980,11 @@
"description": "V1 error format.",
"type": "string"
},
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
"alt": {
"description": "Data format for response.",
"default": "json",
@@ -969,56 +1001,35 @@
],
"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"
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
+ "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"
}
},
"schemas": {
"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"
+ },
"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`.",
- "type": "object"
+ "id": "Binding"
},
"SeekRequest": {
"description": "Request for the `Seek` method.",
@@ -1037,6 +1048,8 @@
"id": "SeekRequest"
},
"ReceivedMessage": {
+ "id": "ReceivedMessage",
+ "description": "A message and its corresponding acknowledgment ID.",
"type": "object",
"properties": {
"ackId": {
@@ -1044,32 +1057,31 @@
"type": "string"
},
"message": {
- "$ref": "PubsubMessage",
- "description": "The message."
+ "description": "The message.",
+ "$ref": "PubsubMessage"
}
- },
- "id": "ReceivedMessage",
- "description": "A message and its corresponding acknowledgment ID."
+ }
},
"PushConfig": {
"type": "object",
"properties": {
"pushEndpoint": {
- "type": "string",
- "description": "A URL locating the endpoint to which messages should be pushed.\nFor example, a Webhook endpoint might use \"https://example.com/push\"."
+ "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"
},
"attributes": {
+ "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the pushed message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the pushed message (i.e., its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub API.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the pushed message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the pushed message (i.e., its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub API.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
- "type": "object"
+ }
}
},
"id": "PushConfig",
"description": "Configuration for a push delivery endpoint."
},
"TestIamPermissionsResponse": {
+ "id": "TestIamPermissionsResponse",
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
"properties": {
@@ -1080,8 +1092,7 @@
"type": "string"
}
}
- },
- "id": "TestIamPermissionsResponse"
+ }
},
"PullRequest": {
"description": "Request for the `Pull` method.",
@@ -1104,11 +1115,11 @@
"type": "object",
"properties": {
"messages": {
- "description": "The messages to publish.",
"type": "array",
"items": {
"$ref": "PubsubMessage"
- }
+ },
+ "description": "The messages to publish."
}
},
"id": "PublishRequest"
@@ -1118,20 +1129,18 @@
"type": "object",
"properties": {
"subscription": {
- "description": "The updated subscription object.",
- "$ref": "Subscription"
+ "$ref": "Subscription",
+ "description": "The updated subscription object."
},
"updateMask": {
+ "type": "string",
"description": "Indicates which fields in the provided subscription to update.\nMust be specified and non-empty.",
- "format": "google-fieldmask",
- "type": "string"
+ "format": "google-fieldmask"
}
},
"id": "UpdateSubscriptionRequest"
},
"PublishResponse": {
- "description": "Response for the `Publish` 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.",
@@ -1141,25 +1150,31 @@
}
}
},
- "id": "PublishResponse"
+ "id": "PublishResponse",
+ "description": "Response for the `Publish` method.",
+ "type": "object"
},
"Subscription": {
- "id": "Subscription",
"description": "A subscription resource.",
"type": "object",
"properties": {
+ "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",
+ "type": "integer"
+ },
"messageRetentionDuration": {
- "type": "string",
"description": "How long to retain unacknowledged messages in the subscription's backlog,\nfrom the moment a message is published.\nIf `retain_acked_messages` is true, then this also configures the retention\nof acknowledged messages, and thus configures how far back in time a `Seek`\ncan be done. Defaults to 7 days. Cannot be more than 7 days or less than 10\nminutes.",
- "format": "google-duration"
+ "format": "google-duration",
+ "type": "string"
},
"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"
+ "type": "boolean",
+ "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."
},
"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"
+ "type": "string",
+ "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\"`."
},
"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.",
@@ -1168,20 +1183,17 @@
"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",
- "type": "integer"
}
- }
+ },
+ "id": "Subscription"
},
"SeekResponse": {
- "id": "SeekResponse",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "SeekResponse"
},
"ModifyAckDeadlineRequest": {
+ "description": "Request for the ModifyAckDeadline method.",
"type": "object",
"properties": {
"ackDeadlineSeconds": {
@@ -1190,23 +1202,22 @@
"type": "integer"
},
"ackIds": {
+ "description": "List of acknowledgment IDs.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "List of acknowledgment IDs."
+ }
}
},
- "id": "ModifyAckDeadlineRequest",
- "description": "Request for the ModifyAckDeadline method."
+ "id": "ModifyAckDeadlineRequest"
},
"Snapshot": {
"description": "A snapshot resource.",
"type": "object",
"properties": {
"name": {
- "type": "string",
- "description": "The name of the snapshot."
+ "description": "The name of the snapshot.",
+ "type": "string"
},
"topic": {
"description": "The name of the topic from which this snapshot is retaining messages.",
@@ -1221,6 +1232,7 @@
"id": "Snapshot"
},
"SetIamPolicyRequest": {
+ "id": "SetIamPolicyRequest",
"description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
@@ -1228,24 +1240,12 @@
"$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"
+ }
},
"PubsubMessage": {
- "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",
"properties": {
- "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"
- },
"attributes": {
"additionalProperties": {
"type": "string"
@@ -1256,10 +1256,22 @@
"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"
},
"ModifyPushConfigRequest": {
+ "id": "ModifyPushConfigRequest",
"description": "Request for the ModifyPushConfig method.",
"type": "object",
"properties": {
@@ -1267,32 +1279,7 @@
"$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` or `StreamingPull` is not called."
}
- },
- "id": "ModifyPushConfigRequest"
- },
- "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"
- },
- "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"
+ }
},
"AcknowledgeRequest": {
"description": "Request for the Acknowledge method.",
@@ -1308,23 +1295,47 @@
},
"id": "AcknowledgeRequest"
},
- "ListTopicSubscriptionsResponse": {
- "description": "Response for the `ListTopicSubscriptions` method.",
+ "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": {
+ "type": "object",
+ "properties": {
+ "topics": {
+ "description": "The resulting topics.",
+ "type": "array",
+ "items": {
+ "$ref": "Topic"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "ListTopicsResponse",
+ "description": "Response for the `ListTopics` method."
+ },
+ "ListTopicSubscriptionsResponse": {
"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.",
"type": "string"
},
"subscriptions": {
- "description": "The names of the subscriptions that match the request.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "The names of the subscriptions that match the request."
}
},
- "id": "ListTopicSubscriptionsResponse"
+ "id": "ListTopicSubscriptionsResponse",
+ "description": "Response for the `ListTopicSubscriptions` method.",
+ "type": "object"
},
"PullResponse": {
"properties": {
@@ -1341,24 +1352,40 @@
"type": "object"
},
"UpdateSnapshotRequest": {
+ "description": "Request for the UpdateSnapshot method.",
"type": "object",
"properties": {
+ "snapshot": {
+ "description": "The updated snpashot object.",
+ "$ref": "Snapshot"
+ },
"updateMask": {
"type": "string",
"description": "Indicates which fields in the provided snapshot to update.\nMust be specified and non-empty.",
"format": "google-fieldmask"
- },
- "snapshot": {
- "description": "The updated snpashot object.",
- "$ref": "Snapshot"
}
},
- "id": "UpdateSnapshotRequest",
- "description": "Request for the UpdateSnapshot method."
+ "id": "UpdateSnapshotRequest"
+ },
+ "ListSnapshotsResponse": {
+ "properties": {
+ "snapshots": {
+ "description": "The resulting snapshots.",
+ "type": "array",
+ "items": {
+ "$ref": "Snapshot"
+ }
+ },
+ "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`.",
+ "type": "string"
+ }
+ },
+ "id": "ListSnapshotsResponse",
+ "description": "Response for the `ListSnapshots` method.",
+ "type": "object"
},
"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.",
@@ -1372,27 +1399,23 @@
}
}
},
- "id": "ListSubscriptionsResponse"
- },
- "ListSnapshotsResponse": {
- "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`.",
- "type": "string"
- },
- "snapshots": {
- "description": "The resulting snapshots.",
- "type": "array",
- "items": {
- "$ref": "Snapshot"
- }
- }
- },
- "id": "ListSnapshotsResponse",
- "description": "Response for the `ListSnapshots` method.",
+ "id": "ListSubscriptionsResponse",
+ "description": "Response for the `ListSubscriptions` method.",
"type": "object"
},
+ "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"
+ },
"ListTopicSnapshotsResponse": {
+ "id": "ListTopicSnapshotsResponse",
"description": "Response for the `ListTopicSnapshots` method.",
"type": "object",
"properties": {
@@ -1407,46 +1430,35 @@
"type": "string"
}
}
- },
- "id": "ListTopicSnapshotsResponse"
- },
- "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"
+ }
},
"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"
- }
+ },
+ "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"
},
"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"
+ "id": "Topic"
},
"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": {
"bindings": {
@@ -1467,14 +1479,13 @@
"type": "integer"
}
},
- "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"
}
},
"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://pubsub.googleapis.com/",
@@ -1493,16 +1504,5 @@
},
"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",
- "revision": "20171205",
- "documentationLink": "https://cloud.google.com/pubsub/docs",
- "id": "pubsub:v1",
- "title": "Google Cloud Pub/Sub API",
- "discoveryVersion": "v1",
- "ownerName": "Google"
+ "servicePath": ""
}
diff --git a/pubsub/v1beta1a/pubsub-api.json b/pubsub/v1beta1a/pubsub-api.json
index 8f8c2d4..f9fdc4c 100644
--- a/pubsub/v1beta1a/pubsub-api.json
+++ b/pubsub/v1beta1a/pubsub-api.json
@@ -1,505 +1,135 @@
{
- "revision": "20171205",
- "documentationLink": "https://cloud.google.com/pubsub/docs",
- "id": "pubsub:v1beta1a",
- "title": "Google Cloud Pub/Sub API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
- "resources": {
- "subscriptions": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListSubscriptionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The value obtained in the last \u003ccode\u003eListSubscriptionsResponse\u003c/code\u003e\nfor continuation.",
- "type": "string"
- },
- "query": {
- "location": "query",
- "description": "A valid label query expression.",
- "type": "string"
- },
- "maxResults": {
- "location": "query",
- "description": "Maximum number of subscriptions to return.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1beta1a/subscriptions",
- "id": "pubsub.subscriptions.list",
- "path": "v1beta1a/subscriptions",
- "description": "Lists matching subscriptions."
- },
- "create": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {},
- "flatPath": "v1beta1a/subscriptions",
- "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"
- },
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
- },
- "acknowledge": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {},
- "flatPath": "v1beta1a/subscriptions/acknowledge",
- "path": "v1beta1a/subscriptions/acknowledge",
- "id": "pubsub.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.",
- "request": {
- "$ref": "AcknowledgeRequest"
- }
- },
- "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.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/subscriptions/modifyAckDeadline"
- },
- "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.",
- "response": {
- "$ref": "PullBatchResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/subscriptions/pullBatch",
- "path": "v1beta1a/subscriptions/pullBatch",
- "id": "pubsub.subscriptions.pullBatch"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "subscription"
- ],
- "parameters": {
- "subscription": {
- "description": "The name of the subscription to get.",
- "required": true,
- "type": "string",
- "pattern": "^.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
- "id": "pubsub.subscriptions.get",
- "path": "v1beta1a/subscriptions/{+subscription}",
- "description": "Gets the configuration details of a subscription."
- },
- "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"
- },
- "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"
- },
- "delete": {
- "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
- "id": "pubsub.subscriptions.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.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "parameters": {
- "subscription": {
- "location": "path",
- "description": "The subscription to delete.",
- "required": true,
- "type": "string",
- "pattern": "^.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
- },
- "pull": {
- "id": "pubsub.subscriptions.pull",
- "path": "v1beta1a/subscriptions/pull",
- "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).",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "PullResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/subscriptions/pull"
- }
- }
- },
- "topics": {
- "methods": {
- "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.",
- "response": {
- "$ref": "Topic"
- },
- "parameterOrder": [
- "topic"
- ],
- "httpMethod": "GET",
- "parameters": {
- "topic": {
- "pattern": "^.+$",
- "location": "path",
- "description": "The name of the topic to get.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/topics/{topicsId}"
- },
- "publish": {
- "id": "pubsub.topics.publish",
- "path": "v1beta1a/topics/publish",
- "request": {
- "$ref": "PublishRequest"
- },
- "description": "Adds a message to the topic. Returns NOT_FOUND if the topic does not\nexist.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/topics/publish"
- },
- "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"
- },
- "parameterOrder": [
- "topic"
- ],
- "httpMethod": "DELETE",
- "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"
- ],
- "flatPath": "v1beta1a/topics/{topicsId}",
- "path": "v1beta1a/topics/{+topic}",
- "id": "pubsub.topics.delete"
- },
- "publishBatch": {
- "flatPath": "v1beta1a/topics/publishBatch",
- "id": "pubsub.topics.publishBatch",
- "path": "v1beta1a/topics/publishBatch",
- "request": {
- "$ref": "PublishBatchRequest"
- },
- "description": "Adds one or more messages to the topic. Returns NOT_FOUND if the topic does\nnot exist.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "PublishBatchResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
- },
- "list": {
- "description": "Lists matching topics.",
- "response": {
- "$ref": "ListTopicsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "The value obtained in the last \u003ccode\u003eListTopicsResponse\u003c/code\u003e\nfor continuation.",
- "type": "string",
- "location": "query"
- },
- "query": {
- "description": "A valid label query expression.",
- "type": "string",
- "location": "query"
- },
- "maxResults": {
- "location": "query",
- "description": "Maximum number of topics to return.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/topics",
- "path": "v1beta1a/topics",
- "id": "pubsub.topics.list"
- },
- "create": {
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/topics",
- "id": "pubsub.topics.create",
- "path": "v1beta1a/topics",
- "request": {
- "$ref": "Topic"
- },
- "description": "Creates the given topic with the given name.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Topic"
- }
- }
- }
- }
- },
- "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"
- },
- "$.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"
- ]
- },
- "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": {
- "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"
- }
- },
"schemas": {
- "ListTopicsResponse": {
- "description": "Response for the ListTopics method.",
+ "Label": {
+ "description": "A key-value pair applied to a given object.",
"type": "object",
"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.",
+ "strValue": {
+ "description": "A string value.",
"type": "string"
},
- "topic": {
- "type": "array",
- "items": {
- "$ref": "Topic"
- },
- "description": "The resulting topics."
+ "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"
}
},
- "id": "ListTopicsResponse"
+ "id": "Label"
},
- "PublishBatchRequest": {
- "description": "Request for the PublishBatch method.",
+ "ModifyAckDeadlineRequest": {
+ "description": "Request for the ModifyAckDeadline method.",
"type": "object",
"properties": {
- "messages": {
- "description": "The messages to publish.",
+ "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",
+ "type": "integer"
+ },
+ "ackIds": {
+ "description": "List of acknowledgment IDs. Either this field or ack_id\nshould be populated, not both.",
"type": "array",
"items": {
- "$ref": "PubsubMessage"
+ "type": "string"
+ }
+ }
+ },
+ "id": "ModifyAckDeadlineRequest"
+ },
+ "PullBatchRequest": {
+ "description": "Request for the PullBatch method.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "PullBatchRequest"
+ },
+ "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"
}
},
- "topic": {
- "description": "The messages in the request will be published on this topic.",
+ "publishTime": {
+ "description": "The time at which the message was published.\nThe time is milliseconds since the UNIX epoch.",
+ "format": "int64",
"type": "string"
}
},
- "id": "PublishBatchRequest"
+ "id": "PubsubMessage"
+ },
+ "ModifyPushConfigRequest": {
+ "description": "Request for the ModifyPushConfig method.",
+ "type": "object",
+ "properties": {
+ "subscription": {
+ "description": "The name of the subscription.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "ModifyPushConfigRequest"
},
"AcknowledgeRequest": {
"description": "Request for the Acknowledge method.",
"type": "object",
"properties": {
+ "subscription": {
+ "description": "The subscription whose message is being acknowledged.",
+ "type": "string"
+ },
"ackId": {
"description": "The acknowledgment ID for the message being acknowledged. This was\nreturned by the Pub/Sub system in the Pull response.",
"type": "array",
"items": {
"type": "string"
}
- },
- "subscription": {
- "description": "The subscription whose message is being acknowledged.",
- "type": "string"
}
},
"id": "AcknowledgeRequest"
},
"PullBatchResponse": {
+ "description": "Response for the PullBatch method.",
"type": "object",
"properties": {
"pullResponses": {
@@ -510,14 +140,49 @@
}
}
},
- "id": "PullBatchResponse",
- "description": "Response for the PullBatch method."
+ "id": "PullBatchResponse"
},
"Empty": {
- "id": "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",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "Empty"
+ },
+ "PublishBatchRequest": {
+ "description": "Request for the PublishBatch method.",
+ "type": "object",
+ "properties": {
+ "topic": {
+ "description": "The messages in the request will be published on this topic.",
+ "type": "string"
+ },
+ "messages": {
+ "description": "The messages to publish.",
+ "type": "array",
+ "items": {
+ "$ref": "PubsubMessage"
+ }
+ }
+ },
+ "id": "PublishBatchRequest"
+ },
+ "ListTopicsResponse": {
+ "description": "Response for the ListTopics method.",
+ "type": "object",
+ "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"
+ }
+ }
+ },
+ "id": "ListTopicsResponse"
},
"PullResponse": {
"description": "Either a \u003ccode\u003ePubsubMessage\u003c/code\u003e or a truncation event. One of these two\nmust be populated.",
@@ -528,8 +193,8 @@
"type": "string"
},
"pubsubEvent": {
- "$ref": "PubsubEvent",
- "description": "A pubsub message or truncation event."
+ "description": "A pubsub message or truncation event.",
+ "$ref": "PubsubEvent"
}
},
"id": "PullResponse"
@@ -546,6 +211,7 @@
"id": "PushConfig"
},
"PullRequest": {
+ "description": "Request for the Pull method.",
"type": "object",
"properties": {
"subscription": {
@@ -557,8 +223,7 @@
"type": "boolean"
}
},
- "id": "PullRequest",
- "description": "Request for the Pull method."
+ "id": "PullRequest"
},
"ListSubscriptionsResponse": {
"description": "Response for the ListSubscriptions method.",
@@ -595,8 +260,8 @@
"type": "boolean"
},
"message": {
- "description": "A received message.",
- "$ref": "PubsubMessage"
+ "$ref": "PubsubMessage",
+ "description": "A received message."
}
},
"id": "PubsubEvent"
@@ -617,10 +282,17 @@
"id": "PublishRequest"
},
"Subscription": {
- "id": "Subscription",
"description": "A subscription resource.",
"type": "object",
"properties": {
+ "topic": {
+ "description": "The name of the topic from which this subscription is receiving messages.",
+ "type": "string"
+ },
+ "pushConfig": {
+ "$ref": "PushConfig",
+ "description": "If push delivery is used with this subscription, this field is\nused to configure it."
+ },
"ackDeadlineSeconds": {
"description": "For either push or pull delivery, the value is the maximum time after a\nsubscriber receives a message before the subscriber should acknowledge or\nNack the message. If the Ack deadline for a message passes without an\nAck or a Nack, the Pub/Sub system will eventually redeliver the message.\nIf a subscriber acknowledges after the deadline, the Pub/Sub system may\naccept the Ack, but it is possible that the message has been already\ndelivered again. Multiple Acks to the message are allowed and will\nsucceed.\n\nFor push delivery, this value is used to set the request timeout for\nthe call to the push endpoint.\n\nFor pull delivery, this value is used as the initial value for the Ack\ndeadline. It may be overridden for each message using its corresponding\nack_id with \u003ccode\u003eModifyAckDeadline\u003c/code\u003e.\nWhile a message is outstanding (i.e. it has been delivered to a pull\nsubscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub\nsystem will not deliver that message to another pull subscriber\n(on a best-effort basis).",
"format": "int32",
@@ -629,16 +301,9 @@
"name": {
"description": "Name of the subscription.",
"type": "string"
- },
- "topic": {
- "description": "The name of the topic from which this subscription is receiving messages.",
- "type": "string"
- },
- "pushConfig": {
- "$ref": "PushConfig",
- "description": "If push delivery is used with this subscription, this field is\nused to configure it."
}
- }
+ },
+ "id": "Subscription"
},
"PublishBatchResponse": {
"description": "Response for the PublishBatch method.",
@@ -655,132 +320,22 @@
"id": "PublishBatchResponse"
},
"Topic": {
+ "description": "A topic resource.",
+ "type": "object",
"properties": {
"name": {
"description": "Name of the topic.",
"type": "string"
}
},
- "id": "Topic",
- "description": "A topic resource.",
- "type": "object"
- },
- "Label": {
- "description": "A key-value pair applied to a given object.",
- "type": "object",
- "properties": {
- "strValue": {
- "description": "A string value.",
- "type": "string"
- },
- "numValue": {
- "description": "An integer value.",
- "format": "int64",
- "type": "string"
- },
- "key": {
- "type": "string",
- "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"
- }
- },
- "id": "Label"
- },
- "ModifyAckDeadlineRequest": {
- "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": {
- "type": "integer",
- "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"
- },
- "ackIds": {
- "description": "List of acknowledgment IDs. Either this field or ack_id\nshould be populated, not both.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ModifyAckDeadlineRequest",
- "description": "Request for the ModifyAckDeadline method."
- },
- "PullBatchRequest": {
- "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",
- "description": "Request for the PullBatch method.",
- "type": "object"
- },
- "ModifyPushConfigRequest": {
- "description": "Request for the ModifyPushConfig method.",
- "type": "object",
- "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"
- },
- "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"
+ "id": "Topic"
}
},
+ "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": "v1beta1a",
"baseUrl": "https://pubsub.googleapis.com/",
"canonicalName": "Pubsub",
@@ -796,12 +351,457 @@
}
}
},
- "servicePath": "",
- "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n",
"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"
+ "batchPath": "batch",
+ "revision": "20171205",
+ "documentationLink": "https://cloud.google.com/pubsub/docs",
+ "id": "pubsub:v1beta1a",
+ "title": "Google Cloud Pub/Sub API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
+ "resources": {
+ "subscriptions": {
+ "methods": {
+ "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": [],
+ "response": {
+ "$ref": "PullBatchResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/subscriptions/pullBatch",
+ "id": "pubsub.subscriptions.pullBatch",
+ "path": "v1beta1a/subscriptions/pullBatch"
+ },
+ "get": {
+ "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
+ "id": "pubsub.subscriptions.get",
+ "path": "v1beta1a/subscriptions/{+subscription}",
+ "description": "Gets the configuration details of a subscription.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameters": {
+ "subscription": {
+ "location": "path",
+ "description": "The name of the subscription to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "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",
+ "id": "pubsub.subscriptions.modifyPushConfig",
+ "path": "v1beta1a/subscriptions/modifyPushConfig"
+ },
+ "delete": {
+ "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
+ "id": "pubsub.subscriptions.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.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "subscription": {
+ "location": "path",
+ "description": "The subscription to delete.",
+ "required": true,
+ "type": "string",
+ "pattern": "^.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "pull": {
+ "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).",
+ "response": {
+ "$ref": "PullResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/subscriptions/pull",
+ "path": "v1beta1a/subscriptions/pull",
+ "id": "pubsub.subscriptions.pull"
+ },
+ "list": {
+ "description": "Lists matching subscriptions.",
+ "response": {
+ "$ref": "ListSubscriptionsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "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": {
+ "description": "Maximum number of subscriptions to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/subscriptions",
+ "path": "v1beta1a/subscriptions",
+ "id": "pubsub.subscriptions.list"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/subscriptions",
+ "id": "pubsub.subscriptions.create",
+ "path": "v1beta1a/subscriptions",
+ "request": {
+ "$ref": "Subscription"
+ },
+ "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."
+ },
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/subscriptions/acknowledge",
+ "id": "pubsub.subscriptions.acknowledge",
+ "path": "v1beta1a/subscriptions/acknowledge"
+ },
+ "modifyAckDeadline": {
+ "flatPath": "v1beta1a/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.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ }
+ }
+ },
+ "topics": {
+ "methods": {
+ "get": {
+ "flatPath": "v1beta1a/topics/{topicsId}",
+ "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.",
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "topic": {
+ "location": "path",
+ "description": "The name of the topic to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^.+$"
+ }
+ }
+ },
+ "publish": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/topics/publish",
+ "path": "v1beta1a/topics/publish",
+ "id": "pubsub.topics.publish",
+ "request": {
+ "$ref": "PublishRequest"
+ },
+ "description": "Adds a message to the topic. Returns NOT_FOUND if the topic does not\nexist."
+ },
+ "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.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "topic"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "topic": {
+ "location": "path",
+ "description": "Name of the topic to delete.",
+ "required": true,
+ "type": "string",
+ "pattern": "^.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/topics/{topicsId}",
+ "id": "pubsub.topics.delete",
+ "path": "v1beta1a/topics/{+topic}"
+ },
+ "publishBatch": {
+ "response": {
+ "$ref": "PublishBatchResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/topics/publishBatch",
+ "path": "v1beta1a/topics/publishBatch",
+ "id": "pubsub.topics.publishBatch",
+ "request": {
+ "$ref": "PublishBatchRequest"
+ },
+ "description": "Adds one or more messages to the topic. Returns NOT_FOUND if the topic does\nnot exist."
+ },
+ "list": {
+ "description": "Lists matching topics.",
+ "response": {
+ "$ref": "ListTopicsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "query": {
+ "description": "A valid label query expression.",
+ "type": "string",
+ "location": "query"
+ },
+ "maxResults": {
+ "location": "query",
+ "description": "Maximum number of topics to return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The value obtained in the last \u003ccode\u003eListTopicsResponse\u003c/code\u003e\nfor continuation.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1a/topics",
+ "path": "v1beta1a/topics",
+ "id": "pubsub.topics.list"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/topics",
+ "id": "pubsub.topics.create",
+ "path": "v1beta1a/topics",
+ "request": {
+ "$ref": "Topic"
+ },
+ "description": "Creates the given topic with the given name."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "$.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"
+ },
+ "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"
+ },
+ "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"
+ }
+ }
}
diff --git a/pubsub/v1beta2/pubsub-api.json b/pubsub/v1beta2/pubsub-api.json
index 21fc2ec..ee0586b 100644
--- a/pubsub/v1beta2/pubsub-api.json
+++ b/pubsub/v1beta2/pubsub-api.json
@@ -1,166 +1,16 @@
{
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"projects": {
"resources": {
"subscriptions": {
"methods": {
- "modifyPushConfig": {
- "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`.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The name of the subscription.",
- "required": true,
- "type": "string"
- }
- },
- "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"
- },
- "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"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The subscription to delete.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "path": "v1beta2/{+subscription}",
- "id": "pubsub.projects.subscriptions.delete"
- },
- "pull": {
- "response": {
- "$ref": "PullResponse"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "parameters": {
- "subscription": {
- "description": "The subscription from which messages should be pulled.",
- "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}: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."
- },
- "list": {
- "description": "Lists matching subscriptions.",
- "response": {
- "$ref": "ListSubscriptionsResponse"
- },
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "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"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of subscriptions to return.",
- "format": "int32",
- "type": "integer"
- },
- "project": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The name of the cloud project that subscriptions belong to.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions",
- "path": "v1beta2/{+project}/subscriptions",
- "id": "pubsub.projects.subscriptions.list"
- },
- "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": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "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."
- },
"create": {
- "path": "v1beta2/{+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. Note that\nfor REST API requests, you must specify a name.",
"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. Note that\nfor REST API requests, you must specify a name.",
"response": {
"$ref": "Subscription"
},
@@ -168,48 +18,112 @@
"name"
],
"httpMethod": "PUT",
+ "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"
+ "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\"`."
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "path": "v1beta2/{+name}",
+ "id": "pubsub.projects.subscriptions.create"
+ },
+ "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"
+ },
+ "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/[^/]+/subscriptions/[^/]+$"
}
},
"scopes": [
"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}: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.",
+ "httpMethod": "GET",
"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.",
+ "required": true,
+ "type": "string"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
+ "id": "pubsub.projects.subscriptions.getIamPolicy",
+ "path": "v1beta2/{+resource}:getIamPolicy"
+ },
+ "modifyAckDeadline": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "subscription": {
+ "description": "The name of the subscription.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"location": "path"
}
},
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
- "path": "v1beta2/{+resource}:getIamPolicy",
- "id": "pubsub.projects.subscriptions.getIamPolicy"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline",
+ "id": "pubsub.projects.subscriptions.modifyAckDeadline",
+ "path": "v1beta2/{+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."
},
"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"
},
@@ -232,13 +146,68 @@
},
"flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}: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"
- }
+ "id": "pubsub.projects.subscriptions.acknowledge"
},
- "modifyAckDeadline": {
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameters": {
+ "subscription": {
+ "location": "path",
+ "description": "The name of the subscription to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "id": "pubsub.projects.subscriptions.get",
+ "path": "v1beta2/{+subscription}",
+ "description": "Gets the configuration details of a subscription."
+ },
+ "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/pubsub"
+ ],
+ "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/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
+ "path": "v1beta2/{+resource}:testIamPermissions",
+ "id": "pubsub.projects.subscriptions.testIamPermissions"
+ },
+ "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"
+ },
"httpMethod": "POST",
"parameterOrder": [
"subscription"
@@ -246,145 +215,164 @@
"response": {
"$ref": "Empty"
},
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The name of the subscription.",
- "required": true,
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline",
- "id": "pubsub.projects.subscriptions.modifyAckDeadline",
- "path": "v1beta2/{+subscription}:modifyAckDeadline",
- "request": {
- "$ref": "ModifyAckDeadlineRequest"
+ "parameters": {
+ "subscription": {
+ "description": "The name of the subscription.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
},
- "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."
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig",
+ "id": "pubsub.projects.subscriptions.modifyPushConfig",
+ "path": "v1beta2/{+subscription}:modifyPushConfig"
},
- "get": {
+ "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": "Subscription"
+ "$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.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:pull"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
+ "description": "The subscription to delete.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListSubscriptionsResponse"
+ },
+ "parameterOrder": [
+ "project"
+ ],
"httpMethod": "GET",
"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.",
+ "pageToken": {
+ "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",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of subscriptions to return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "project": {
+ "description": "The name of the cloud project that subscriptions belong to.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
}
},
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "path": "v1beta2/{+subscription}",
- "id": "pubsub.projects.subscriptions.get",
- "description": "Gets the configuration details of a subscription."
- },
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "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"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
- "path": "v1beta2/{+resource}:testIamPermissions",
- "id": "pubsub.projects.subscriptions.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"
- }
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions",
+ "path": "v1beta2/{+project}/subscriptions",
+ "id": "pubsub.projects.subscriptions.list",
+ "description": "Lists matching subscriptions."
}
}
},
"topics": {
- "methods": {
- "publish": {
- "response": {
- "$ref": "PublishResponse"
- },
- "parameterOrder": [
- "topic"
- ],
- "httpMethod": "POST",
- "parameters": {
- "topic": {
- "description": "The messages in the request will be published on this topic.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
+ "resources": {
+ "subscriptions": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListTopicSubscriptionsResponse"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "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.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Maximum number of subscription names to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "topic": {
+ "description": "The name of the topic that subscriptions are attached to.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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."
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}: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."
- },
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "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 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"
}
- },
+ }
+ },
+ "methods": {
"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_`.",
"response": {
"$ref": "Empty"
},
@@ -392,25 +380,26 @@
"topic"
],
"httpMethod": "DELETE",
- "parameters": {
- "topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "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": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
"flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
"path": "v1beta2/{+topic}",
- "id": "pubsub.projects.topics.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_`."
+ "id": "pubsub.projects.topics.delete"
},
"list": {
+ "path": "v1beta2/{+project}/topics",
+ "id": "pubsub.projects.topics.list",
"description": "Lists matching topics.",
"response": {
"$ref": "ListTopicsResponse"
@@ -419,6 +408,10 @@
"project"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"parameters": {
"pageToken": {
"location": "query",
@@ -439,44 +432,10 @@
"location": "path"
}
},
- "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"
- },
- "create": {
- "id": "pubsub.projects.topics.create",
- "path": "v1beta2/{+name}",
- "request": {
- "$ref": "Topic"
- },
- "description": "Creates the given topic with the given name.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Topic"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "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\"`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}"
+ "flatPath": "v1beta2/projects/{projectsId}/topics"
},
"setIamPolicy": {
+ "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.",
@@ -496,17 +455,44 @@
],
"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"
+ }
+ }
+ },
+ "create": {
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
+ "path": "v1beta2/{+name}",
+ "id": "pubsub.projects.topics.create",
+ "description": "Creates the given topic with the given name.",
+ "request": {
+ "$ref": "Topic"
+ },
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "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\"`.",
+ "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"
},
@@ -516,11 +502,11 @@
"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/[^/]+/topics/[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field."
}
},
"scopes": [
@@ -529,11 +515,10 @@
],
"flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
"path": "v1beta2/{+resource}:getIamPolicy",
- "id": "pubsub.projects.topics.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": {
- "path": "v1beta2/{+topic}",
- "id": "pubsub.projects.topics.get",
"description": "Gets the configuration of a topic.",
"response": {
"$ref": "Topic"
@@ -544,61 +529,78 @@
"httpMethod": "GET",
"parameters": {
"topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
"description": "The name of the topic to get.",
"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}"
- }
- },
- "resources": {
- "subscriptions": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListTopicSubscriptionsResponse"
- },
- "parameterOrder": [
- "topic"
- ],
- "httpMethod": "GET",
- "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.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Maximum number of subscription names to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "The name of the topic that subscriptions are attached to.",
- "required": true,
- "type": "string"
- }
- },
- "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."
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
+ "path": "v1beta2/{+topic}",
+ "id": "pubsub.projects.topics.get"
+ },
+ "publish": {
+ "response": {
+ "$ref": "PublishResponse"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "topic": {
+ "location": "path",
+ "description": "The messages in the request will be published on this topic.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}: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."
+ },
+ "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/pubsub"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:testIamPermissions",
+ "path": "v1beta2/{+resource}:testIamPermissions",
+ "id": "pubsub.projects.topics.testIamPermissions"
}
}
}
@@ -606,53 +608,6 @@
}
},
"parameters": {
- "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": {
- "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": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
@@ -670,8 +625,13 @@
"type": "string"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
"type": "string"
},
"$.xgafv": {
@@ -687,48 +647,69 @@
],
"location": "query"
},
- "callback": {
+ "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": "JSONP",
+ "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": {
+ "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": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
}
},
"schemas": {
- "ModifyAckDeadlineRequest": {
+ "ModifyPushConfigRequest": {
+ "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",
- "type": "integer"
- },
- "ackIds": {
- "description": "List of acknowledgment IDs.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "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"
}
},
- "id": "ModifyAckDeadlineRequest",
- "description": "Request for the ModifyAckDeadline method.",
- "type": "object"
- },
- "SetIamPolicyRequest": {
- "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",
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object"
+ "id": "ModifyPushConfigRequest",
+ "description": "Request for the ModifyPushConfig method."
},
"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).",
@@ -752,40 +733,52 @@
"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": {
- "properties": {
- "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",
- "description": "Request for the ModifyPushConfig method.",
- "type": "object"
+ "id": "PubsubMessage"
},
"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"
- }
+ },
+ "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": {
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
}
+ }
+ },
+ "ListTopicsResponse": {
+ "type": "object",
+ "properties": {
+ "topics": {
+ "type": "array",
+ "items": {
+ "$ref": "Topic"
+ },
+ "description": "The resulting topics."
+ },
+ "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"
+ }
},
- "id": "Binding"
+ "id": "ListTopicsResponse",
+ "description": "Response for the `ListTopics` method."
+ },
+ "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": {}
},
"AcknowledgeRequest": {
+ "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.",
@@ -796,40 +789,14 @@
}
},
"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"
+ "description": "Request for the Acknowledge method."
},
"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.",
- "type": "string"
+ "type": "string",
+ "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."
},
"subscriptions": {
"description": "The names of the subscriptions that match the request.",
@@ -839,7 +806,8 @@
}
}
},
- "id": "ListTopicSubscriptionsResponse"
+ "id": "ListTopicSubscriptionsResponse",
+ "description": "Response for the `ListTopicSubscriptions` method."
},
"PullResponse": {
"description": "Response for the `Pull` method.",
@@ -856,19 +824,19 @@
"id": "PullResponse"
},
"ReceivedMessage": {
+ "description": "A message and its corresponding acknowledgment ID.",
+ "type": "object",
"properties": {
- "message": {
- "description": "The message.",
- "$ref": "PubsubMessage"
- },
"ackId": {
"description": "This ID can be used to acknowledge the received message.",
"type": "string"
+ },
+ "message": {
+ "$ref": "PubsubMessage",
+ "description": "The message."
}
},
- "id": "ReceivedMessage",
- "description": "A message and its corresponding acknowledgment ID.",
- "type": "object"
+ "id": "ReceivedMessage"
},
"PushConfig": {
"description": "Configuration for a push delivery endpoint.",
@@ -879,16 +847,18 @@
"type": "string"
},
"attributes": {
+ "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the push message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the envelope (i.e. its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub\nAPI.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the push message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the envelope (i.e. its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub\nAPI.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
- "type": "object"
+ }
}
},
"id": "PushConfig"
},
"TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
@@ -898,11 +868,12 @@
}
}
},
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object"
+ "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.",
@@ -913,14 +884,9 @@
"format": "int32",
"type": "integer"
}
- },
- "id": "PullRequest",
- "description": "Request for the `Pull` method.",
- "type": "object"
+ }
},
"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.",
@@ -934,9 +900,14 @@
}
}
},
- "id": "ListSubscriptionsResponse"
+ "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.",
@@ -945,12 +916,11 @@
"$ref": "PubsubMessage"
}
}
- },
- "id": "PublishRequest",
- "description": "Request for the Publish method.",
- "type": "object"
+ }
},
"PublishResponse": {
+ "description": "Response for the `Publish` 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.",
@@ -960,12 +930,19 @@
}
}
},
- "id": "PublishResponse",
- "description": "Response for the `Publish` method.",
- "type": "object"
+ "id": "PublishResponse"
},
"Subscription": {
+ "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.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.",
+ "type": "string"
+ },
"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.",
"$ref": "PushConfig"
@@ -974,21 +951,14 @@
"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.",
"format": "int32",
"type": "integer"
- },
- "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.\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"
+ "description": "A subscription resource."
},
"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).",
@@ -998,22 +968,12 @@
}
}
},
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object"
- },
- "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"
+ "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).",
+ "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.",
@@ -1026,21 +986,63 @@
"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"
+ },
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error."
+ }
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "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",
+ "type": "integer"
+ },
+ "ackIds": {
+ "description": "List of acknowledgment IDs.",
+ "type": "array",
+ "items": {
+ "type": "string"
}
}
},
- "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": "ModifyAckDeadlineRequest"
+ },
+ "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"
}
},
"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": "v1beta2",
@@ -1049,27 +1051,25 @@
"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"
}
}
}
},
"kind": "discovery#restDescription",
- "servicePath": "",
"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",
"revision": "20171205",
- "documentationLink": "https://cloud.google.com/pubsub/docs",
"id": "pubsub:v1beta2",
- "title": "Google Cloud Pub/Sub API",
- "discoveryVersion": "v1",
- "ownerName": "Google"
+ "documentationLink": "https://cloud.google.com/pubsub/docs",
+ "title": "Google Cloud Pub/Sub API"
}
diff --git a/runtimeconfig/v1/runtimeconfig-api.json b/runtimeconfig/v1/runtimeconfig-api.json
index 0118e0d..9e87d9f 100644
--- a/runtimeconfig/v1/runtimeconfig-api.json
+++ b/runtimeconfig/v1/runtimeconfig-api.json
@@ -1,11 +1,213 @@
{
+ "resources": {
+ "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": "^operations/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "runtimeconfig.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`."
+ },
+ "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": "^operations/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "runtimeconfig.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`."
+ },
+ "list": {
+ "flatPath": "v1/operations",
+ "path": "v1/{+name}",
+ "id": "runtimeconfig.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",
+ "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": {
+ "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"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "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"
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "version": "v1",
+ "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:v1",
"documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
+ "id": "runtimeconfig:v1",
"revision": "20171030",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "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"
+ },
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"type": "object",
@@ -13,8 +215,18 @@
"id": "CancelOperationRequest"
},
"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": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
@@ -23,29 +235,19 @@
"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",
- "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."
+ "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"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
"nextPageToken": {
- "type": "string",
- "description": "The standard List next-page token."
+ "description": "The standard List next-page token.",
+ "type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
@@ -58,51 +260,45 @@
"id": "ListOperationsResponse"
},
"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": {
- "type": "object",
- "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."
- },
- "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": {
- "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`."
+ "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": {
- "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."
+ "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."
- },
- "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": "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"
+ "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": {
@@ -123,201 +319,5 @@
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Cloud Runtime Configuration API",
- "ownerName": "Google",
- "resources": {
- "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"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be 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": {
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "runtimeconfig.operations.delete"
- },
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations$"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1/operations",
- "path": "v1/{+name}",
- "id": "runtimeconfig.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."
- }
- }
- }
- },
- "parameters": {
- "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."
- },
- "uploadType": {
- "type": "string",
- "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."
- },
- "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": {
- "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"
- },
- "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."
- }
- },
- "version": "v1",
- "baseUrl": "https://runtimeconfig.googleapis.com/",
- "kind": "discovery#restDescription",
- "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.",
- "servicePath": ""
+ "ownerName": "Google"
}
diff --git a/runtimeconfig/v1beta1/runtimeconfig-api.json b/runtimeconfig/v1beta1/runtimeconfig-api.json
index 29abdd1..aeeed7e 100644
--- a/runtimeconfig/v1beta1/runtimeconfig-api.json
+++ b/runtimeconfig/v1beta1/runtimeconfig-api.json
@@ -1,977 +1,22 @@
{
- "resources": {
- "projects": {
- "resources": {
- "configs": {
- "methods": {
- "get": {
- "response": {
- "$ref": "RuntimeConfig"
- },
- "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 RuntimeConfig resource to retrieve, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.get",
- "description": "Gets information about a RuntimeConfig resource."
- },
- "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": {
- "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": "^projects/[^/]+/configs/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.testIamPermissions"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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}",
- "id": "runtimeconfig.projects.configs.delete",
- "path": "v1beta1/{+name}",
- "description": "Deletes a RuntimeConfig resource."
- },
- "list": {
- "response": {
- "$ref": "ListConfigsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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/[^/]+$",
- "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"
- },
- "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"
- }
- },
- "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.list",
- "description": "Lists all the RuntimeConfig resources within project."
- },
- "create": {
- "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.",
- "response": {
- "$ref": "RuntimeConfig"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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": {
- "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",
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ]
- },
- "setIamPolicy": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:setIamPolicy",
- "path": "v1beta1/{+resource}:setIamPolicy",
- "id": "runtimeconfig.projects.configs.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/cloudruntimeconfig"
- ],
- "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"
- }
- }
- },
- "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",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:getIamPolicy",
- "path": "v1beta1/{+resource}:getIamPolicy",
- "id": "runtimeconfig.projects.configs.getIamPolicy"
- }
- },
- "resources": {
- "operations": {
- "methods": {
- "testIamPermissions": {
- "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/[^/]+/configs/[^/]+/operations/.+$"
- }
- },
- "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",
- "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": {
- "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/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.operations.get"
- }
- }
- },
- "waiters": {
- "methods": {
- "create": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
- "id": "runtimeconfig.projects.configs.waiters.create",
- "path": "v1beta1/{+parent}/waiters",
- "request": {
- "$ref": "Waiter"
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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 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",
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ]
- },
- "testIamPermissions": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}:testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.waiters.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": {
- "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/[^/]+/waiters/[^/]+$",
- "location": "path"
- }
- }
- },
- "delete": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
- "id": "runtimeconfig.projects.configs.waiters.delete",
- "path": "v1beta1/{+name}",
- "description": "Deletes the waiter with the specified name.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "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"
- ]
- },
- "list": {
- "description": "List waiters within the given configuration.",
- "response": {
- "$ref": "ListWaitersResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "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"
- }
- },
- "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"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Waiter"
- },
- "parameterOrder": [
- "name"
- ],
- "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}",
- "id": "runtimeconfig.projects.configs.waiters.get",
- "path": "v1beta1/{+name}",
- "description": "Gets information about a single waiter."
- }
- }
- },
- "variables": {
- "methods": {
- "update": {
- "request": {
- "$ref": "Variable"
- },
- "description": "Updates an existing variable with a new value.",
- "response": {
- "$ref": "Variable"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path",
- "description": "The name of the variable to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_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}/variables/{variablesId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.variables.update"
- },
- "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": {
- "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/[^/]+/configs/[^/]+/variables/.+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.variables.testIamPermissions"
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "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"
- }
- },
- "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}",
- "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."
- },
- "list": {
- "path": "v1beta1/{+parent}/variables",
- "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.",
- "response": {
- "$ref": "ListVariablesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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": {
- "location": "query",
- "description": "Filters variables by matching the specified filter. For example:\n\n`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.",
- "type": "string"
- },
- "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"
- },
- "returnValues": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables"
- },
- "create": {
- "response": {
- "$ref": "Variable"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "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 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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables",
- "path": "v1beta1/{+parent}/variables",
- "id": "runtimeconfig.projects.configs.variables.create",
- "request": {
- "$ref": "Variable"
- },
- "description": "Creates a variable within the given configuration. You cannot create\na variable with a name that is a prefix of an existing variable name, or a\nname that has an existing variable name as a prefix.\n\nTo learn more about creating a variable, read the\n[Setting and Getting Data](/deployment-manager/runtime-configurator/set-and-get-variables)\ndocumentation."
- },
- "get": {
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.variables.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"
- }
- }
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Variable"
- },
- "parameters": {
- "name": {
- "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "required": true,
- "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}:watch",
- "id": "runtimeconfig.projects.configs.variables.watch",
- "path": "v1beta1/{+name}:watch"
- }
- }
- }
- }
- }
- }
- }
- },
- "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": {
- "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": {
- "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": {
- "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"
- }
- },
- "version": "v1beta1",
- "baseUrl": "https://runtimeconfig.googleapis.com/",
- "kind": "discovery#restDescription",
- "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.",
- "servicePath": "",
- "basePath": "",
- "id": "runtimeconfig:v1beta1",
- "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
- "revision": "20171030",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "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": {
- "description": {
- "description": "An optional description of the RuntimeConfig object.",
- "type": "string"
- },
- "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\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"
- }
- },
- "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": {
- "waiters": {
- "description": "Found waiters in the project.",
- "type": "array",
- "items": {
- "$ref": "Waiter"
- }
- },
- "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": "ListWaitersResponse"
- },
- "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": {
- "error": {
- "description": "[Output Only] If the waiter ended due to a failure or timeout, this value\nwill be set.",
- "$ref": "Status"
- },
- "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": {
- "$ref": "EndCondition",
- "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."
- },
- "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"
- }
- },
- "id": "Waiter"
- },
- "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).",
- "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"
- },
- "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"
- }
- },
- "id": "Variable"
- },
"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."
@@ -987,29 +32,18 @@
"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."
},
"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"
+ "$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"
@@ -1018,10 +52,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": {
- "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",
@@ -1037,37 +67,33 @@
"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": {
+ "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"
+ },
"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": {
- "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"
+ }
},
"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`.",
@@ -1079,22 +105,30 @@
"type": "integer"
}
},
- "id": "Cardinality"
+ "id": "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"
+ },
+ "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"
}
+ },
+ "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": "ListConfigsResponse"
@@ -1123,12 +157,189 @@
}
},
"id": "TestIamPermissionsResponse"
+ },
+ "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": {
+ "type": "string",
+ "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\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."
+ },
+ "description": {
+ "description": "An optional description of the RuntimeConfig object.",
+ "type": "string"
+ }
+ },
+ "id": "RuntimeConfig"
+ },
+ "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"
+ }
+ },
+ "id": "WatchVariableRequest"
+ },
+ "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": {
+ "type": "object",
+ "properties": {
+ "failure": {
+ "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.",
+ "$ref": "EndCondition"
+ },
+ "success": {
+ "$ref": "EndCondition",
+ "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."
+ },
+ "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"
+ },
+ "done": {
+ "type": "boolean",
+ "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."
+ },
+ "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."
+ },
+ "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": {
+ "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": {
+ "updateTime": {
+ "type": "string",
+ "description": "[Output Only] The time of the last variable update.",
+ "format": "google-datetime"
+ },
+ "state": {
+ "type": "string",
+ "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."
+ },
+ "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": {
+ "type": "string",
+ "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."
+ },
+ "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"
+ }
+ },
+ "id": "Variable"
+ },
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "Binding"
+ },
+ "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error."
+ }
+ },
+ "id": "Policy"
}
},
"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": {
@@ -1149,5 +360,794 @@
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Cloud Runtime Configuration API",
- "ownerName": "Google"
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "configs": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The RuntimeConfig resource to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+$"
+ }
+ },
+ "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.delete",
+ "description": "Deletes a RuntimeConfig resource."
+ },
+ "list": {
+ "description": "Lists all the RuntimeConfig resources within project.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListConfigsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "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": {
+ "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": {
+ "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",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs",
+ "id": "runtimeconfig.projects.configs.list",
+ "path": "v1beta1/{+parent}/configs"
+ },
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "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 is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:setIamPolicy",
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "id": "runtimeconfig.projects.configs.setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ }
+ },
+ "create": {
+ "request": {
+ "$ref": "RuntimeConfig"
+ },
+ "description": "Creates a new RuntimeConfig resource. The configuration name must be\nunique within project.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "RuntimeConfig"
+ },
+ "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": {
+ "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",
+ "id": "runtimeconfig.projects.configs.create",
+ "path": "v1beta1/{+parent}/configs"
+ },
+ "getIamPolicy": {
+ "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/[^/]+/configs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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."
+ },
+ "get": {
+ "response": {
+ "$ref": "RuntimeConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.get",
+ "description": "Gets information about a RuntimeConfig resource."
+ },
+ "update": {
+ "id": "runtimeconfig.projects.configs.update",
+ "path": "v1beta1/{+name}",
+ "request": {
+ "$ref": "RuntimeConfig"
+ },
+ "description": "Updates a RuntimeConfig resource. The configuration must exist beforehand.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "RuntimeConfig"
+ },
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "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]`"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}"
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "resource": {
+ "required": true,
+ "type": "string",
+ "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."
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.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"
+ }
+ }
+ },
+ "resources": {
+ "variables": {
+ "methods": {
+ "delete": {
+ "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"
+ ],
+ "parameters": {
+ "name": {
+ "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",
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$"
+ },
+ "recursive": {
+ "description": "Set to `true` to recursively delete multiple variables with the same\nprefix.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "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}"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListVariablesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "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"
+ },
+ "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"
+ },
+ "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 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"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables",
+ "path": "v1beta1/{+parent}/variables",
+ "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": {
+ "$ref": "Variable"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "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": {
+ "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",
+ "pattern": "^projects/[^/]+/configs/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables",
+ "path": "v1beta1/{+parent}/variables",
+ "id": "runtimeconfig.projects.configs.variables.create",
+ "description": "Creates a variable within the given configuration. You cannot create\na variable with a name that is a prefix of an existing variable name, or a\nname that has an existing variable name as a prefix.\n\nTo learn more about creating a variable, read the\n[Setting and Getting Data](/deployment-manager/runtime-configurator/set-and-get-variables)\ndocumentation.",
+ "request": {
+ "$ref": "Variable"
+ }
+ },
+ "get": {
+ "response": {
+ "$ref": "Variable"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "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": {
+ "response": {
+ "$ref": "Variable"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path"
+ }
+ },
+ "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"
+ }
+ },
+ "update": {
+ "response": {
+ "$ref": "Variable"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path",
+ "description": "The name of the variable to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_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}/variables/{variablesId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.variables.update",
+ "request": {
+ "$ref": "Variable"
+ },
+ "description": "Updates an existing variable with a new value."
+ },
+ "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",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.variables.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"
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "testIamPermissions": {
+ "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/[^/]+/configs/[^/]+/operations/.+$"
+ }
+ },
+ "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",
+ "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"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ }
+ },
+ "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": "^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}",
+ "id": "runtimeconfig.projects.configs.operations.get",
+ "path": "v1beta1/{+name}"
+ }
+ }
+ },
+ "waiters": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$",
+ "location": "path",
+ "description": "The Waiter resource to delete, in the format:\n\n `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`"
+ }
+ },
+ "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",
+ "description": "Deletes the waiter with the specified name."
+ },
+ "list": {
+ "id": "runtimeconfig.projects.configs.waiters.list",
+ "path": "v1beta1/{+parent}/waiters",
+ "description": "List waiters within the given configuration.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListWaitersResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "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": {
+ "required": true,
+ "type": "string",
+ "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]`"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters"
+ },
+ "get": {
+ "description": "Gets information about a single waiter.",
+ "response": {
+ "$ref": "Waiter"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "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",
+ "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.waiters.get"
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "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": {
+ "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",
+ "pattern": "^projects/[^/]+/configs/[^/]+$"
+ }
+ },
+ "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.create",
+ "request": {
+ "$ref": "Waiter"
+ },
+ "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."
+ },
+ "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": {
+ "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/[^/]+/configs/[^/]+/waiters/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}:testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.waiters.testIamPermissions"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "type": "string",
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ },
+ "$.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"
+ ]
+ },
+ "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": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Pretty-print response."
+ }
+ },
+ "version": "v1beta1",
+ "baseUrl": "https://runtimeconfig.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "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.",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20171030",
+ "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
+ "id": "runtimeconfig:v1beta1"
}
diff --git a/safebrowsing/v4/safebrowsing-api.json b/safebrowsing/v4/safebrowsing-api.json
index e916611..8cceb41 100644
--- a/safebrowsing/v4/safebrowsing-api.json
+++ b/safebrowsing/v4/safebrowsing-api.json
@@ -1,52 +1,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": {
- "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",
- "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",
@@ -60,9 +34,12 @@
"2"
]
},
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
+ },
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -74,138 +51,221 @@
"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": {
+ "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"
},
- "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": "OAuth access token.",
- "type": "string"
+ "description": "Pretty-print response."
+ },
+ "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."
}
},
"schemas": {
- "Constraints": {
- "id": "Constraints",
- "description": "The constraints for this update.",
+ "RawIndices": {
+ "description": "A set of raw indices to remove from a local list.",
"type": "object",
"properties": {
- "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.",
- "format": "int32",
- "type": "integer"
- },
- "maxDatabaseEntries": {
- "description": "Sets the maximum number of entries that the client is willing to have\nin the local database. This should be a power of 2 between 2**10 and\n2**20. If zero, no database size limit is set.",
- "format": "int32",
- "type": "integer"
- },
- "region": {
- "description": "Requests the list for a specific geographic location. If not set the\nserver may pick that value based on the user's IP address. Expects ISO\n3166-1 alpha-2 format.",
- "type": "string"
- },
- "supportedCompressions": {
- "description": "The compression types supported by the client.",
+ "indices": {
+ "description": "The indices to remove from a lexicographically-sorted local list.",
"type": "array",
"items": {
- "type": "string",
- "enum": [
- "COMPRESSION_TYPE_UNSPECIFIED",
- "RAW",
- "RICE"
- ]
- },
- "enumDescriptions": [
- "Unknown.",
- "Raw, uncompressed data.",
- "Rice-Golomb encoded data."
- ]
+ "format": "int32",
+ "type": "integer"
+ }
}
- }
+ },
+ "id": "RawIndices"
},
- "RiceDeltaEncoding": {
- "id": "RiceDeltaEncoding",
- "description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or\ncompressed removal indices.",
+ "ThreatSource": {
+ "description": "A single resource related to a threat hit.",
"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": {
+ "enum": [
+ "THREAT_SOURCE_TYPE_UNSPECIFIED",
+ "MATCHING_URL",
+ "TAB_URL",
+ "TAB_REDIRECT",
+ "TAB_RESOURCE"
+ ],
+ "description": "The type of source reported.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown.",
+ "The URL that matched the threat list (for which GetFullHash returned a\nvalid hash).",
+ "The final top-level URL of the tab that the client was browsing when the\nmatch occurred.",
+ "A redirect URL that was fetched before hitting the final TAB_URL.",
+ "A resource loaded within the final TAB_URL."
+ ]
+ },
+ "url": {
+ "description": "The URL of the resource.",
"type": "string"
},
- "encodedData": {
- "description": "The encoded deltas that are encoded using the Golomb-Rice coder.",
+ "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": {
+ "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"
},
- "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"
+ "regionCode": {
+ "description": "The UN M.49 region code associated with the user's location.",
+ "type": "string"
}
- }
+ },
+ "id": "UserInfo"
},
- "ListThreatListsResponse": {
- "id": "ListThreatListsResponse",
+ "FetchThreatListUpdatesResponse": {
"type": "object",
"properties": {
- "threatLists": {
- "description": "The lists available for download by the client.",
+ "listUpdateResponses": {
+ "description": "The list updates requested by the clients.",
"type": "array",
"items": {
- "$ref": "ThreatListDescriptor"
+ "$ref": "ListUpdateResponse"
}
+ },
+ "minimumWaitDuration": {
+ "description": "The minimum duration the client must wait before issuing any update\nrequest. If this field is not set clients may update as soon as they want.",
+ "format": "google-duration",
+ "type": "string"
}
- }
+ },
+ "id": "FetchThreatListUpdatesResponse"
},
- "FindThreatMatchesResponse": {
- "id": "FindThreatMatchesResponse",
+ "FindFullHashesResponse": {
"type": "object",
"properties": {
+ "minimumWaitDuration": {
+ "description": "The minimum duration the client must wait before issuing any find hashes\nrequest. If this field is not set, clients can issue a request as soon as\nthey want.",
+ "format": "google-duration",
+ "type": "string"
+ },
"matches": {
- "description": "The threat list matches.",
+ "description": "The full hashes that matched the requested prefixes.",
"type": "array",
"items": {
"$ref": "ThreatMatch"
}
+ },
+ "negativeCacheDuration": {
+ "description": "For requested entities that did not match the threat list, how long to\ncache the response.",
+ "format": "google-duration",
+ "type": "string"
}
- }
+ },
+ "id": "FindFullHashesResponse"
},
- "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.",
+ "Checksum": {
+ "description": "The expected state of a client's local database.",
"type": "object",
"properties": {
- "threatEntryType": {
- "description": "The entry types contained in the list.",
+ "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"
+ },
+ "ThreatHit": {
+ "type": "object",
+ "properties": {
+ "clientInfo": {
+ "$ref": "ClientInfo",
+ "description": "Client-reported identification."
+ },
+ "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": [
- "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"
+ "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": {
+ "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.",
@@ -227,12 +287,57 @@
"ANY_PLATFORM",
"ALL_PLATFORMS",
"CHROME"
+ ]
+ },
+ "userInfo": {
+ "description": "Details about the user that encountered the threat.",
+ "$ref": "UserInfo"
+ }
+ },
+ "id": "ThreatHit"
+ },
+ "ThreatEntrySet": {
+ "description": "A set of threats that should be added or removed from a client's local\ndatabase.",
+ "type": "object",
+ "properties": {
+ "compressionType": {
+ "enumDescriptions": [
+ "Unknown.",
+ "Raw, uncompressed data.",
+ "Rice-Golomb encoded data."
],
- "description": "The platform type targeted by the list's entries.",
+ "enum": [
+ "COMPRESSION_TYPE_UNSPECIFIED",
+ "RAW",
+ "RICE"
+ ],
+ "description": "The compression type for the entries in this set.",
"type": "string"
},
+ "riceIndices": {
+ "$ref": "RiceDeltaEncoding",
+ "description": "The encoded local, lexicographically-sorted list indices, using a\nGolomb-Rice encoding. Used for sending compressed removal indices. The\nremoval indices (uint32) are sorted in ascending order, then delta encoded\nand stored as encoded_data."
+ },
+ "rawIndices": {
+ "$ref": "RawIndices",
+ "description": "The raw removal indices for a local list."
+ },
+ "rawHashes": {
+ "description": "The raw SHA256-formatted entries.",
+ "$ref": "RawHashes"
+ },
+ "riceHashes": {
+ "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.",
+ "$ref": "RiceDeltaEncoding"
+ }
+ },
+ "id": "ThreatEntrySet"
+ },
+ "ListUpdateRequest": {
+ "description": "A single list update request.",
+ "type": "object",
+ "properties": {
"threatType": {
- "description": "The threat type posed by the list's entries.",
"type": "string",
"enumDescriptions": [
"Unknown.",
@@ -265,13 +370,252 @@
"CLIENT_INCIDENT_WHITELIST",
"APK_MALWARE_OFFLINE",
"SUBRESOURCE_FILTER"
+ ],
+ "description": "The type of threat posed by entries present in the list."
+ },
+ "constraints": {
+ "$ref": "Constraints",
+ "description": "The constraints associated with this request."
+ },
+ "threatEntryType": {
+ "description": "The types of entries present in the list.",
+ "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"
+ ]
+ },
+ "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": {
+ "enum": [
+ "PLATFORM_TYPE_UNSPECIFIED",
+ "WINDOWS",
+ "LINUX",
+ "ANDROID",
+ "OSX",
+ "IOS",
+ "ANY_PLATFORM",
+ "ALL_PLATFORMS",
+ "CHROME"
+ ],
+ "description": "The type of platform at risk by entries present in the list.",
+ "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."
+ ]
+ }
+ },
+ "id": "ListUpdateRequest"
+ },
+ "Constraints": {
+ "description": "The constraints for this update.",
+ "type": "object",
+ "properties": {
+ "maxDatabaseEntries": {
+ "description": "Sets the maximum number of entries that the client is willing to have\nin the local database. This should be a power of 2 between 2**10 and\n2**20. If zero, no database size limit is set.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "region": {
+ "description": "Requests the list for a specific geographic location. If not set the\nserver may pick that value based on the user's IP address. Expects ISO\n3166-1 alpha-2 format.",
+ "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"
+ ]
+ }
+ },
+ "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.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Constraints"
+ },
+ "ListThreatListsResponse": {
+ "type": "object",
+ "properties": {
+ "threatLists": {
+ "type": "array",
+ "items": {
+ "$ref": "ThreatListDescriptor"
+ },
+ "description": "The lists available for download by the client."
+ }
+ },
+ "id": "ListThreatListsResponse"
+ },
+ "RiceDeltaEncoding": {
+ "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",
+ "description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or\ncompressed removal indices."
+ },
+ "FindThreatMatchesResponse": {
+ "type": "object",
+ "properties": {
+ "matches": {
+ "description": "The threat list matches.",
+ "type": "array",
+ "items": {
+ "$ref": "ThreatMatch"
+ }
+ }
+ },
+ "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": {
+ "platformType": {
+ "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 targeted by the list's entries.",
+ "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 threat type posed by the list's entries.",
+ "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."
+ ]
+ },
+ "threatEntryType": {
+ "enum": [
+ "THREAT_ENTRY_TYPE_UNSPECIFIED",
+ "URL",
+ "EXECUTABLE",
+ "IP_RANGE",
+ "CHROME_EXTENSION",
+ "FILENAME",
+ "CERT"
+ ],
+ "description": "The entry types contained in the list.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "A URL.",
+ "An executable program.",
+ "An IP range.",
+ "Chrome extension.",
+ "Filename.",
+ "CERT"
]
}
},
"id": "ThreatListDescriptor"
},
"ClientInfo": {
- "id": "ClientInfo",
"description": "The client metadata associated with Safe Browsing API requests.",
"type": "object",
"properties": {
@@ -283,7 +627,8 @@
"description": "The version of the client implementation.",
"type": "string"
}
- }
+ },
+ "id": "ClientInfo"
},
"ThreatInfo": {
"description": "The information regarding one or more threats that a client submits when\nchecking for matches in threat lists.",
@@ -377,7 +722,6 @@
"description": "The entry types to be checked.",
"type": "array",
"items": {
- "type": "string",
"enum": [
"THREAT_ENTRY_TYPE_UNSPECIFIED",
"URL",
@@ -386,66 +730,54 @@
"CHROME_EXTENSION",
"FILENAME",
"CERT"
- ]
+ ],
+ "type": "string"
}
}
},
"id": "ThreatInfo"
},
"ThreatEntryMetadata": {
- "id": "ThreatEntryMetadata",
- "description": "The metadata associated with a specific threat entry. The client is expected\nto know the metadata key/value pairs associated with each threat type.",
- "type": "object",
"properties": {
"entries": {
- "description": "The metadata entries.",
"type": "array",
"items": {
"$ref": "MetadataEntry"
- }
+ },
+ "description": "The metadata entries."
}
- }
+ },
+ "id": "ThreatEntryMetadata",
+ "description": "The metadata associated with a specific threat entry. The client is expected\nto know the metadata key/value pairs associated with each threat type.",
+ "type": "object"
},
"RawHashes": {
- "id": "RawHashes",
- "description": "The uncompressed threat entries in hash format of a particular prefix length.\nHashes can be anywhere from 4 to 32 bytes in size. A large majority are 4\nbytes, but some hashes are lengthened if they collide with the hash of a\npopular URL.\n\nUsed for sending ThreatEntrySet to clients that do not support compression,\nor when sending non-4-byte hashes to clients that do support compression.",
"type": "object",
"properties": {
+ "rawHashes": {
+ "type": "string",
+ "description": "The hashes, in binary format, concatenated into one long string. Hashes are\nsorted in lexicographic order. For JSON API users, hashes are\nbase64-encoded.",
+ "format": "byte"
+ },
"prefixSize": {
"description": "The number of bytes for each prefix encoded below. This field can be\nanywhere from 4 (shortest prefix) to 32 (full SHA256 hash).",
"format": "int32",
"type": "integer"
- },
- "rawHashes": {
- "description": "The hashes, in binary format, concatenated into one long string. Hashes are\nsorted in lexicographic order. For JSON API users, hashes are\nbase64-encoded.",
- "format": "byte",
- "type": "string"
}
- }
+ },
+ "id": "RawHashes",
+ "description": "The uncompressed threat entries in hash format of a particular prefix length.\nHashes can be anywhere from 4 to 32 bytes in size. A large majority are 4\nbytes, but some hashes are lengthened if they collide with the hash of a\npopular URL.\n\nUsed for sending ThreatEntrySet to clients that do not support compression,\nor when sending non-4-byte hashes to clients that do support compression."
},
"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": {}
+ "properties": {},
+ "id": "Empty"
},
"FindFullHashesRequest": {
- "id": "FindFullHashesRequest",
"description": "Request to return full hashes matched by the provided hash prefixes.",
"type": "object",
"properties": {
- "apiClient": {
- "$ref": "ClientInfo",
- "description": "Client metadata associated with callers of higher-level APIs built on top\nof the client's implementation."
- },
- "clientStates": {
- "description": "The current client states for each of the client's local threat lists.",
- "type": "array",
- "items": {
- "format": "byte",
- "type": "string"
- }
- },
"client": {
"$ref": "ClientInfo",
"description": "The client metadata."
@@ -453,8 +785,21 @@
"threatInfo": {
"$ref": "ThreatInfo",
"description": "The lists and hashes to be checked."
+ },
+ "apiClient": {
+ "$ref": "ClientInfo",
+ "description": "Client metadata associated with callers of higher-level APIs built on top\nof the client's implementation."
+ },
+ "clientStates": {
+ "type": "array",
+ "items": {
+ "format": "byte",
+ "type": "string"
+ },
+ "description": "The current client states for each of the client's local threat lists."
}
- }
+ },
+ "id": "FindFullHashesRequest"
},
"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",
@@ -468,8 +813,8 @@
}
},
"client": {
- "description": "The client metadata.",
- "$ref": "ClientInfo"
+ "$ref": "ClientInfo",
+ "description": "The client metadata."
}
},
"id": "FetchThreatListUpdatesRequest"
@@ -478,6 +823,79 @@
"description": "An update to an individual list.",
"type": "object",
"properties": {
+ "additions": {
+ "description": "A set of entries to add to a local threat type's list. Repeated to allow\nfor a combination of compressed and raw data to be sent in a single\nresponse.",
+ "type": "array",
+ "items": {
+ "$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."
+ ]
+ },
+ "threatType": {
+ "description": "The threat type for which data is returned.",
+ "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"
+ ]
+ },
+ "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",
+ "items": {
+ "$ref": "ThreatEntrySet"
+ }
+ },
"platformType": {
"enumDescriptions": [
"Unknown platform.",
@@ -525,49 +943,20 @@
"FILENAME",
"CERT"
]
- },
- "additions": {
- "description": "A set of entries to add to a local threat type's list. Repeated to allow\nfor a combination of compressed and raw data to be sent in a single\nresponse.",
- "type": "array",
- "items": {
- "$ref": "ThreatEntrySet"
- }
- },
- "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"
- },
- "responseType": {
- "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"
- ]
+ }
+ },
+ "id": "ListUpdateResponse"
+ },
+ "ThreatMatch": {
+ "description": "A match when checking a threat entry in the Safe Browsing threat lists.",
+ "type": "object",
+ "properties": {
+ "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": {
- "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",
@@ -584,33 +973,36 @@
"APK_MALWARE_OFFLINE",
"SUBRESOURCE_FILTER"
],
- "description": "The threat type for which data is returned.",
- "type": "string"
+ "description": "The threat type matching this threat.",
+ "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."
+ ]
},
- "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",
- "items": {
- "$ref": "ThreatEntrySet"
- }
+ "threatEntryMetadata": {
+ "$ref": "ThreatEntryMetadata",
+ "description": "Optional metadata associated with this threat."
},
- "newClientState": {
- "description": "The new client state, in encrypted format. Opaque to clients.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "ListUpdateResponse"
- },
- "ThreatMatch": {
- "description": "A match when checking a threat entry in the Safe Browsing threat lists.",
- "type": "object",
- "properties": {
"threat": {
- "$ref": "ThreatEntry",
- "description": "The threat matching this threat."
+ "description": "The threat matching this threat.",
+ "$ref": "ThreatEntry"
},
"platformType": {
+ "description": "The platform type matching this threat.",
+ "type": "string",
"enumDescriptions": [
"Unknown platform.",
"Threat posed to Windows.",
@@ -632,9 +1024,7 @@
"ANY_PLATFORM",
"ALL_PLATFORMS",
"CHROME"
- ],
- "description": "The platform type matching this threat.",
- "type": "string"
+ ]
},
"threatEntryType": {
"description": "The threat entry type matching this threat.",
@@ -657,63 +1047,16 @@
"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.",
- "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"
- ]
- },
- "threatEntryMetadata": {
- "description": "Optional metadata associated with this threat.",
- "$ref": "ThreatEntryMetadata"
}
},
"id": "ThreatMatch"
},
"ThreatEntry": {
- "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",
"properties": {
"url": {
- "description": "A URL.",
- "type": "string"
+ "type": "string",
+ "description": "A URL."
},
"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.",
@@ -721,388 +1064,45 @@
"type": "string"
},
"hash": {
+ "type": "string",
"description": "A hash prefix, consisting of the most significant 4-32 bytes of a SHA256\nhash. This field is in binary format. For JSON requests, hashes are\nbase64-encoded.",
- "format": "byte",
- "type": "string"
+ "format": "byte"
}
- }
+ },
+ "id": "ThreatEntry",
+ "description": "An individual threat; for example, a malicious URL or its hash\nrepresentation. Only one of these fields should be set."
},
"MetadataEntry": {
- "id": "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"
},
"FindThreatMatchesRequest": {
"description": "Request to check entries against lists.",
"type": "object",
"properties": {
"client": {
- "description": "The client metadata.",
- "$ref": "ClientInfo"
+ "$ref": "ClientInfo",
+ "description": "The client metadata."
},
"threatInfo": {
- "description": "The lists and entries to be checked for matches.",
- "$ref": "ThreatInfo"
+ "$ref": "ThreatInfo",
+ "description": "The lists and entries to be checked for matches."
}
},
"id": "FindThreatMatchesRequest"
- },
- "ThreatSource": {
- "description": "A single resource related to a threat hit.",
- "type": "object",
- "properties": {
- "referrer": {
- "description": "Referrer of the resource. Only set if the referrer is available.",
- "type": "string"
- },
- "type": {
- "description": "The type of source reported.",
- "type": "string",
- "enumDescriptions": [
- "Unknown.",
- "The URL that matched the threat list (for which GetFullHash returned a\nvalid hash).",
- "The final top-level URL of the tab that the client was browsing when the\nmatch occurred.",
- "A redirect URL that was fetched before hitting the final TAB_URL.",
- "A resource loaded within the final TAB_URL."
- ],
- "enum": [
- "THREAT_SOURCE_TYPE_UNSPECIFIED",
- "MATCHING_URL",
- "TAB_URL",
- "TAB_REDIRECT",
- "TAB_RESOURCE"
- ]
- },
- "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"
- }
- },
- "id": "ThreatSource"
- },
- "RawIndices": {
- "id": "RawIndices",
- "description": "A set of raw indices to remove from a local list.",
- "type": "object",
- "properties": {
- "indices": {
- "description": "The indices to remove from a lexicographically-sorted local list.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- }
- }
- },
- "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"
- },
- "FetchThreatListUpdatesResponse": {
- "id": "FetchThreatListUpdatesResponse",
- "type": "object",
- "properties": {
- "listUpdateResponses": {
- "description": "The list updates requested by the clients.",
- "type": "array",
- "items": {
- "$ref": "ListUpdateResponse"
- }
- },
- "minimumWaitDuration": {
- "description": "The minimum duration the client must wait before issuing any update\nrequest. If this field is not set clients may update as soon as they want.",
- "format": "google-duration",
- "type": "string"
- }
- }
- },
- "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"
- }
- }
- },
- "FindFullHashesResponse": {
- "id": "FindFullHashesResponse",
- "type": "object",
- "properties": {
- "minimumWaitDuration": {
- "description": "The minimum duration the client must wait before issuing any find hashes\nrequest. If this field is not set, clients can issue a request as soon as\nthey want.",
- "format": "google-duration",
- "type": "string"
- },
- "matches": {
- "description": "The full hashes that matched the requested prefixes.",
- "type": "array",
- "items": {
- "$ref": "ThreatMatch"
- }
- },
- "negativeCacheDuration": {
- "description": "For requested entities that did not match the threat list, how long to\ncache the response.",
- "format": "google-duration",
- "type": "string"
- }
- }
- },
- "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": {
- "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 reported.",
- "type": "string"
- },
- "userInfo": {
- "description": "Details about the user that encountered the threat.",
- "$ref": "UserInfo"
- },
- "clientInfo": {
- "description": "Client-reported identification.",
- "$ref": "ClientInfo"
- }
- },
- "id": "ThreatHit"
- },
- "ThreatEntrySet": {
- "id": "ThreatEntrySet",
- "description": "A set of threats that should be added or removed from a client's local\ndatabase.",
- "type": "object",
- "properties": {
- "compressionType": {
- "enumDescriptions": [
- "Unknown.",
- "Raw, uncompressed data.",
- "Rice-Golomb encoded data."
- ],
- "enum": [
- "COMPRESSION_TYPE_UNSPECIFIED",
- "RAW",
- "RICE"
- ],
- "description": "The compression type for the entries in this set.",
- "type": "string"
- },
- "riceIndices": {
- "description": "The encoded local, lexicographically-sorted list indices, using a\nGolomb-Rice encoding. Used for sending compressed removal indices. The\nremoval indices (uint32) are sorted in ascending order, then delta encoded\nand stored as encoded_data.",
- "$ref": "RiceDeltaEncoding"
- },
- "rawIndices": {
- "$ref": "RawIndices",
- "description": "The raw removal indices for a local list."
- },
- "rawHashes": {
- "$ref": "RawHashes",
- "description": "The raw SHA256-formatted entries."
- },
- "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."
- }
- }
- },
- "ListUpdateRequest": {
- "id": "ListUpdateRequest",
- "description": "A single list update request.",
- "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 types of entries present in the list.",
- "type": "string"
- },
- "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": {
- "description": "The type of platform at risk by entries present in the list.",
- "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"
- ]
- },
- "threatType": {
- "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"
- ],
- "description": "The type of threat posed by entries present in the list.",
- "type": "string"
- },
- "constraints": {
- "description": "The constraints associated with this request.",
- "$ref": "Constraints"
- }
- }
}
},
"protocol": "rest",
@@ -1120,52 +1120,142 @@
"ownerDomain": "google.com",
"name": "safebrowsing",
"batchPath": "batch",
- "id": "safebrowsing:v4",
- "documentationLink": "https://developers.google.com/safe-browsing/",
"revision": "20171212",
+ "documentationLink": "https://developers.google.com/safe-browsing/",
+ "id": "safebrowsing:v4",
"title": "Google Safe Browsing API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
- "fullHashes": {
+ "threatHits": {
"methods": {
- "find": {
+ "create": {
"request": {
- "$ref": "FindFullHashesRequest"
+ "$ref": "ThreatHit"
},
- "description": "Finds the full hashes that match the requested hash prefixes.",
+ "description": "Reports a Safe Browsing threat list hit to Google. Only projects with\nTRUSTED_REPORTER visibility can use this method.",
"response": {
- "$ref": "FindFullHashesResponse"
+ "$ref": "Empty"
},
"parameterOrder": [],
"httpMethod": "POST",
"parameters": {},
+ "flatPath": "v4/threatHits",
+ "path": "v4/threatHits",
+ "id": "safebrowsing.threatHits.create"
+ }
+ }
+ },
+ "encodedFullHashes": {
+ "methods": {
+ "get": {
+ "parameters": {
+ "clientId": {
+ "location": "query",
+ "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",
+ "location": "query"
+ },
+ "encodedRequest": {
+ "location": "path",
+ "description": "A serialized FindFullHashesRequest proto.",
+ "format": "byte",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v4/encodedFullHashes/{encodedRequest}",
+ "id": "safebrowsing.encodedFullHashes.get",
+ "path": "v4/encodedFullHashes/{encodedRequest}",
+ "description": "",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "FindFullHashesResponse"
+ },
+ "parameterOrder": [
+ "encodedRequest"
+ ]
+ }
+ }
+ },
+ "threatLists": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListThreatListsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {},
+ "flatPath": "v4/threatLists",
+ "path": "v4/threatLists",
+ "id": "safebrowsing.threatLists.list",
+ "description": "Lists the Safe Browsing threat lists available for download."
+ }
+ }
+ },
+ "threatMatches": {
+ "methods": {
+ "find": {
+ "response": {
+ "$ref": "FindThreatMatchesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "flatPath": "v4/threatMatches:find",
+ "path": "v4/threatMatches:find",
+ "id": "safebrowsing.threatMatches.find",
+ "description": "Finds the threat entries that match the Safe Browsing lists.",
+ "request": {
+ "$ref": "FindThreatMatchesRequest"
+ }
+ }
+ }
+ },
+ "fullHashes": {
+ "methods": {
+ "find": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "FindFullHashesResponse"
+ },
+ "parameters": {},
"flatPath": "v4/fullHashes:find",
+ "id": "safebrowsing.fullHashes.find",
"path": "v4/fullHashes:find",
- "id": "safebrowsing.fullHashes.find"
+ "request": {
+ "$ref": "FindFullHashesRequest"
+ },
+ "description": "Finds the full hashes that match the requested hash prefixes."
}
}
},
"encodedUpdates": {
"methods": {
"get": {
- "httpMethod": "GET",
"response": {
"$ref": "FetchThreatListUpdatesResponse"
},
"parameterOrder": [
"encodedRequest"
],
+ "httpMethod": "GET",
"parameters": {
"clientId": {
+ "location": "query",
"description": "A client ID that uniquely identifies the client implementation of the Safe\nBrowsing API.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"clientVersion": {
- "description": "The version of the client implementation.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "The version of the client implementation."
},
"encodedRequest": {
"location": "path",
@@ -1176,8 +1266,8 @@
}
},
"flatPath": "v4/encodedUpdates/{encodedRequest}",
- "id": "safebrowsing.encodedUpdates.get",
"path": "v4/encodedUpdates/{encodedRequest}",
+ "id": "safebrowsing.encodedUpdates.get",
"description": ""
}
}
@@ -1200,96 +1290,6 @@
"description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once."
}
}
- },
- "encodedFullHashes": {
- "methods": {
- "get": {
- "path": "v4/encodedFullHashes/{encodedRequest}",
- "id": "safebrowsing.encodedFullHashes.get",
- "description": "",
- "response": {
- "$ref": "FindFullHashesResponse"
- },
- "parameterOrder": [
- "encodedRequest"
- ],
- "httpMethod": "GET",
- "parameters": {
- "encodedRequest": {
- "description": "A serialized FindFullHashesRequest proto.",
- "format": "byte",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clientId": {
- "location": "query",
- "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
- "type": "string"
- },
- "clientVersion": {
- "location": "query",
- "description": "The version of the client implementation.",
- "type": "string"
- }
- },
- "flatPath": "v4/encodedFullHashes/{encodedRequest}"
- }
- }
- },
- "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"
- }
- }
- },
- "threatLists": {
- "methods": {
- "list": {
- "path": "v4/threatLists",
- "id": "safebrowsing.threatLists.list",
- "description": "Lists the Safe Browsing threat lists available for download.",
- "response": {
- "$ref": "ListThreatListsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {},
- "flatPath": "v4/threatLists"
- }
- }
- },
- "threatMatches": {
- "methods": {
- "find": {
- "request": {
- "$ref": "FindThreatMatchesRequest"
- },
- "description": "Finds the threat entries that match the Safe Browsing lists.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "FindThreatMatchesResponse"
- },
- "parameters": {},
- "flatPath": "v4/threatMatches:find",
- "id": "safebrowsing.threatMatches.find",
- "path": "v4/threatMatches:find"
- }
- }
}
}
}
diff --git a/script/v1/script-api.json b/script/v1/script-api.json
index af473ba..19900fa 100644
--- a/script/v1/script-api.json
+++ b/script/v1/script-api.json
@@ -1,18 +1,15 @@
{
- "discoveryVersion": "v1",
- "ownerName": "Google",
"resources": {
"scripts": {
"methods": {
"run": {
- "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"
- }
+ "response": {
+ "$ref": "Operation"
},
+ "parameterOrder": [
+ "scriptId"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://mail.google.com/",
"https://www.google.com/calendar/feeds",
@@ -26,63 +23,59 @@
"https://www.googleapis.com/auth/spreadsheets",
"https://www.googleapis.com/auth/userinfo.email"
],
+ "parameters": {
+ "scriptId": {
+ "location": "path",
+ "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"
+ }
+ },
"flatPath": "v1/scripts/{scriptId}:run",
- "id": "script.scripts.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"
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "scriptId"
- ],
- "response": {
- "$ref": "Operation"
}
}
}
}
},
"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",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "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"
+ },
+ "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",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"alt": {
"enumDescriptions": [
@@ -100,40 +93,48 @@
],
"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"
},
+ "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",
"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"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
}
},
"schemas": {
"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": {
"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.",
@@ -144,17 +145,14 @@
"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"
+ }
}
- },
- "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"
+ }
},
"ScriptStackTraceElement": {
"description": "A stack trace through the script that shows where the execution failed.",
@@ -173,29 +171,36 @@
"id": "ScriptStackTraceElement"
},
"ExecutionError": {
+ "id": "ExecutionError",
+ "description": "An object that provides information about the nature of an error resulting\nfrom an attempted execution of a script function using the Apps Script API.\nIf a run call\nsucceeds but the script function (or Apps Script itself) throws an exception,\nthe response body's error field\ncontains a\nStatus object. The `Status` object's `details` field\ncontains an array with a single one of these `ExecutionError` objects.",
+ "type": "object",
"properties": {
"errorType": {
- "type": "string",
- "description": "The error type, for example `TypeError` or `ReferenceError`. If the error\ntype is unavailable, this field is not included."
+ "description": "The error type, for example `TypeError` or `ReferenceError`. If the error\ntype is unavailable, this field is not included.",
+ "type": "string"
},
"errorMessage": {
"description": "The error message thrown by Apps Script, usually localized into the user's\nlanguage.",
"type": "string"
},
"scriptStackTraceElements": {
+ "description": "An array of objects that provide a stack trace through the script to show\nwhere the execution failed, with the deepest call first.",
"type": "array",
"items": {
"$ref": "ScriptStackTraceElement"
- },
- "description": "An array of objects that provide a stack trace through the script to show\nwhere the execution failed, with the deepest call first."
+ }
}
- },
- "id": "ExecutionError",
- "description": "An object that provides information about the nature of an error resulting\nfrom an attempted execution of a script function using the Apps Script API.\nIf a run call\nsucceeds but the script function (or Apps Script itself) throws an exception,\nthe response body's error field\ncontains a\nStatus object. The `Status` object's `details` field\ncontains an array with a single one of these `ExecutionError` objects.",
- "type": "object"
+ }
},
"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": {
+ "message": {
+ "description": "A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the [google.rpc.Status.details](google.rpc.Status.details) field, or localized by the client.",
+ "type": "string"
+ },
"details": {
"description": "An array that contains a single ExecutionError object that provides information about the nature of the error.",
"type": "array",
@@ -211,57 +216,50 @@
"description": "The status code. For this API, this value either: \u003cul\u003e \u003cli\u003e 3, indicating an `INVALID_ARGUMENT` error, or\u003c/li\u003e \u003cli\u003e 1, indicating a `CANCELLED` execution.\u003c/li\u003e \u003c/ul\u003e",
"format": "int32",
"type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the [google.rpc.Status.details](google.rpc.Status.details) field, or localized by the client.",
- "type": "string"
}
- },
- "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"
+ }
},
"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.",
"type": "object",
"properties": {
- "sessionState": {
- "type": "string",
- "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."
- },
"function": {
"description": "The name of the function to execute in the given script. The name does not\ninclude parentheses or parameters.",
"type": "string"
},
"devMode": {
- "type": "boolean",
- "description": "If `true` and the user is an owner of the script, the script runs at the\nmost recently saved version rather than the version deployed for use with\nthe Apps Script API. Optional; default is `false`."
+ "description": "If `true` and the user is an owner of the script, the script runs at the\nmost recently saved version rather than the version deployed for use with\nthe Apps Script API. Optional; default is `false`.",
+ "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.",
+ "type": "string"
}
},
- "id": "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."
+ "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",
- "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"
+ "id": "ExecutionResponse"
}
},
"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": "v1",
@@ -269,6 +267,9 @@
"auth": {
"oauth2": {
"scopes": {
+ "https://www.google.com/m8/feeds": {
+ "description": "Manage your contacts"
+ },
"https://www.googleapis.com/auth/userinfo.email": {
"description": "View your email address"
},
@@ -290,23 +291,20 @@
"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://mail.google.com/": {
+ "description": "Read, send, delete, and manage your email"
+ },
"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"
}
}
}
},
- "servicePath": "",
"description": "An API for managing and executing Google Apps Script projects.",
+ "servicePath": "",
"kind": "discovery#restDescription",
"rootUrl": "https://script.googleapis.com/",
"basePath": "",
@@ -317,5 +315,7 @@
"documentationLink": "https://developers.google.com/apps-script/execution/rest/v1/scripts/run",
"id": "script:v1",
"fullyEncodeReservedExpansion": true,
- "title": "Google Apps Script API"
+ "title": "Google Apps Script API",
+ "discoveryVersion": "v1",
+ "ownerName": "Google"
}
diff --git a/searchconsole/v1/searchconsole-api.json b/searchconsole/v1/searchconsole-api.json
index 2b0e98d..1b591ec 100644
--- a/searchconsole/v1/searchconsole-api.json
+++ b/searchconsole/v1/searchconsole-api.json
@@ -1,4 +1,24 @@
{
+ "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://searchconsole.googleapis.com/",
+ "canonicalName": "Search Console",
+ "kind": "discovery#restDescription",
+ "description": "Provides tools for running validation tests against single URLs",
+ "servicePath": "",
+ "rootUrl": "https://searchconsole.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "searchconsole",
+ "batchPath": "batch",
+ "revision": "20171211",
+ "documentationLink": "https://developers.google.com/webmaster-tools/search-console-api/",
+ "id": "searchconsole:v1",
+ "title": "Google Search Console URL Testing Tools API",
"ownerName": "Google",
"discoveryVersion": "v1",
"version_module": true,
@@ -8,10 +28,6 @@
"mobileFriendlyTest": {
"methods": {
"run": {
- "description": "Runs Mobile-Friendly Test for a given URL.",
- "request": {
- "$ref": "RunMobileFriendlyTestRequest"
- },
"response": {
"$ref": "RunMobileFriendlyTestResponse"
},
@@ -20,7 +36,11 @@
"parameters": {},
"flatPath": "v1/urlTestingTools/mobileFriendlyTest:run",
"path": "v1/urlTestingTools/mobileFriendlyTest:run",
- "id": "searchconsole.urlTestingTools.mobileFriendlyTest.run"
+ "id": "searchconsole.urlTestingTools.mobileFriendlyTest.run",
+ "description": "Runs Mobile-Friendly Test for a given URL.",
+ "request": {
+ "$ref": "RunMobileFriendlyTestRequest"
+ }
}
}
}
@@ -28,9 +48,35 @@
}
},
"parameters": {
+ "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": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -42,7 +88,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"
},
"key": {
"location": "query",
@@ -55,9 +103,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"
+ "type": "string",
+ "location": "query"
},
"pp": {
"description": "Pretty-print response.",
@@ -66,62 +114,33 @@
"location": "query"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"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."
},
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
"type": "boolean",
"default": "true",
"location": "query",
"description": "Returns response with indentations and line breaks."
- },
- "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": {
- "type": "string",
- "location": "query",
- "description": "JSONP"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
}
},
"schemas": {
"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).",
@@ -139,41 +158,15 @@
"SIZE_CONTENT_TO_VIEWPORT",
"USE_LEGIBLE_FONT_SIZES",
"TAP_TARGETS_TOO_CLOSE"
- ]
+ ],
+ "description": "Rule violated.",
+ "type": "string"
}
},
- "id": "MobileFriendlyIssue",
- "description": "Mobile-friendly issue."
+ "id": "MobileFriendlyIssue"
},
"RunMobileFriendlyTestResponse": {
- "description": "Mobile-friendly test response, including mobile-friendly issues and resource\nissues.",
- "type": "object",
"properties": {
- "mobileFriendliness": {
- "description": "Test verdict, whether the page is mobile friendly or not.",
- "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."
- ],
- "enum": [
- "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED",
- "MOBILE_FRIENDLY",
- "NOT_MOBILE_FRIENDLY"
- ]
- },
- "mobileFriendlyIssues": {
- "description": "List of mobile-usability issues.",
- "type": "array",
- "items": {
- "$ref": "MobileFriendlyIssue"
- }
- },
- "screenshot": {
- "description": "Screenshot of the requested URL.",
- "$ref": "Image"
- },
"testStatus": {
"description": "Final state of the test, can be either complete or an error.",
"$ref": "TestStatus"
@@ -184,9 +177,36 @@
"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"
+ },
+ "mobileFriendlyIssues": {
+ "type": "array",
+ "items": {
+ "$ref": "MobileFriendlyIssue"
+ },
+ "description": "List of mobile-usability issues."
+ },
+ "screenshot": {
+ "$ref": "Image",
+ "description": "Screenshot of the requested URL."
}
},
- "id": "RunMobileFriendlyTestResponse"
+ "id": "RunMobileFriendlyTestResponse",
+ "description": "Mobile-friendly test response, including mobile-friendly issues and resource\nissues.",
+ "type": "object"
},
"ResourceIssue": {
"description": "Information about a resource with issue.",
@@ -215,12 +235,6 @@
"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",
@@ -228,7 +242,13 @@
"PAGE_UNREACHABLE"
],
"description": "Status of the test.",
- "type": "string"
+ "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."
+ ]
},
"details": {
"description": "Error details if applicable.",
@@ -258,8 +278,8 @@
"type": "object",
"properties": {
"url": {
- "description": "URL for inspection.",
- "type": "string"
+ "type": "string",
+ "description": "URL for inspection."
},
"requestScreenshot": {
"description": "Whether or not screenshot is requested. Default is false.",
@@ -268,25 +288,5 @@
},
"id": "RunMobileFriendlyTestRequest"
}
- },
- "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://searchconsole.googleapis.com/",
- "canonicalName": "Search Console",
- "kind": "discovery#restDescription",
- "description": "Provides tools for running validation tests against single URLs",
- "servicePath": "",
- "rootUrl": "https://searchconsole.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "searchconsole",
- "batchPath": "batch",
- "revision": "20171211",
- "documentationLink": "https://developers.google.com/webmaster-tools/search-console-api/",
- "id": "searchconsole:v1",
- "title": "Google Search Console URL Testing Tools API"
+ }
}
diff --git a/serviceconsumermanagement/v1/serviceconsumermanagement-api.json b/serviceconsumermanagement/v1/serviceconsumermanagement-api.json
index d8a98e2..813ed11 100644
--- a/serviceconsumermanagement/v1/serviceconsumermanagement-api.json
+++ b/serviceconsumermanagement/v1/serviceconsumermanagement-api.json
@@ -1,186 +1,110 @@
{
- "ownerDomain": "google.com",
- "name": "serviceconsumermanagement",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Service Consumer Management API",
- "ownerName": "Google",
"resources": {
- "operations": {
- "methods": {
- "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": {
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled."
- }
- },
- "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": {
- "flatPath": "v1/operations/{operationsId}",
- "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": {
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted."
- }
- }
- },
- "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",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^operations$",
- "location": "path",
- "description": "The name of the operation's parent resource."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The standard list page token."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/operations",
- "id": "serviceconsumermanagement.operations.list",
- "path": "v1/{+name}"
- },
- "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"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource."
- }
- }
- }
- }
- },
"services": {
"methods": {
"search": {
- "httpMethod": "GET",
+ "description": "Search tenancy units for a service.",
"response": {
"$ref": "SearchTenancyUnitsResponse"
},
"parameterOrder": [
"parent"
],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "query": {
- "type": "string",
- "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."
- },
- "parent": {
- "required": true,
- "type": "string",
- "pattern": "^services/[^/]+$",
- "location": "path",
- "description": "Service for which search is performed.\nservices/{service}\n{service} the name of a service, for example 'service.googleapis.com'."
- },
"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",
- "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."
+ "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": {
+ "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": {
+ "location": "path",
+ "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/[^/]+$"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/services/{servicesId}:search",
- "id": "serviceconsumermanagement.services.search",
"path": "v1/{+parent}:search",
- "description": "Search tenancy units for a service."
+ "id": "serviceconsumermanagement.services.search"
}
},
"resources": {
"tenancyUnits": {
"methods": {
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "Name of the tenancy unit to be deleted.",
+ "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}",
+ "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."
+ },
+ "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"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Name of the tenancy unit.",
+ "required": true,
+ "type": "string",
+ "pattern": "^services/[^/]+/[^/]+/[^/]+/tenancyUnits/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:addProject",
+ "path": "v1/{+parent}:addProject",
+ "id": "serviceconsumermanagement.services.tenancyUnits.addProject"
+ },
"list": {
+ "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits",
+ "path": "v1/{+parent}/tenancyUnits",
+ "id": "serviceconsumermanagement.services.tenancyUnits.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"
},
@@ -188,40 +112,40 @@
"parent"
],
"httpMethod": "GET",
- "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"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "The maximum number of results returned by this request.",
- "format": "int32"
- },
- "parent": {
- "required": true,
- "type": "string",
- "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'."
- },
- "filter": {
- "location": "query",
- "description": "Filter expression over tenancy resources field. Optional.",
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits",
- "path": "v1/{+parent}/tenancyUnits",
- "id": "serviceconsumermanagement.services.tenancyUnits.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."
+ "parameters": {
+ "pageSize": {
+ "description": "The maximum number of results returned by this request.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "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"
+ },
+ "filter": {
+ "description": "Filter expression over tenancy resources field. Optional.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "type": "string",
+ "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."
+ }
+ }
},
"create": {
+ "request": {
+ "$ref": "CreateTenancyUnitRequest"
+ },
+ "description": "Creates a tenancy unit with no tenant resources.",
"response": {
"$ref": "TenancyUnit"
},
@@ -231,11 +155,11 @@
"httpMethod": "POST",
"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",
- "pattern": "^services/[^/]+/[^/]+/[^/]+$"
+ "type": "string"
}
},
"scopes": [
@@ -243,127 +167,212 @@
],
"flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits",
"path": "v1/{+parent}/tenancyUnits",
- "id": "serviceconsumermanagement.services.tenancyUnits.create",
- "request": {
- "$ref": "CreateTenancyUnitRequest"
- },
- "description": "Creates a tenancy unit with no tenant resources."
+ "id": "serviceconsumermanagement.services.tenancyUnits.create"
},
"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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Operation"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
- "location": "path",
"description": "Name of the tenancy unit.\nSuch as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'.",
"required": true,
"type": "string",
- "pattern": "^services/[^/]+/[^/]+/[^/]+/tenancyUnits/[^/]+$"
+ "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",
- "path": "v1/{+name}:removeProject"
- },
- "delete": {
- "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}",
- "id": "serviceconsumermanagement.services.tenancyUnits.delete",
- "path": "v1/{+name}",
- "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"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Name of the tenancy unit to be deleted.",
- "required": true,
- "type": "string",
- "pattern": "^services/[^/]+/[^/]+/[^/]+/tenancyUnits/[^/]+$"
- }
- }
- },
- "addProject": {
+ "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.",
"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"
- ],
- "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:addProject",
- "path": "v1/{+parent}:addProject",
- "id": "serviceconsumermanagement.services.tenancyUnits.addProject"
+ "$ref": "RemoveTenantProjectRequest"
+ }
}
}
}
}
+ },
+ "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`.",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "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",
+ "path": "v1/{+name}:cancel",
+ "id": "serviceconsumermanagement.operations.cancel"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be deleted.",
+ "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}",
+ "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`."
+ },
+ "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": {
+ "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": {
+ "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/service.management"
+ ]
+ },
+ "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": {
+ "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}",
+ "id": "serviceconsumermanagement.operations.get",
+ "path": "v1/{+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": {
+ "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",
- "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\")."
+ "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": {
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -373,10 +382,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": [
@@ -389,70 +403,1102 @@
"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"
+ "type": "string",
+ "location": "query"
},
"access_token": {
- "type": "string",
"location": "query",
- "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": {
- "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.",
+ "description": "OAuth access token.",
"type": "string"
}
},
"version": "v1",
"baseUrl": "https://serviceconsumermanagement.googleapis.com/",
"servicePath": "",
- "kind": "discovery#restDescription",
"description": "Provides management methods for configuring service producer resources on Google Cloud.",
+ "kind": "discovery#restDescription",
"basePath": "",
- "id": "serviceconsumermanagement:v1",
"documentationLink": "https://cloud.google.com/service-consumer-management/docs/overview",
+ "id": "serviceconsumermanagement:v1",
"revision": "20171214",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "SystemParameter": {
+ "BackendRule": {
+ "description": "A backend rule provides configuration for an individual API element.",
"type": "object",
"properties": {
- "httpHeader": {
+ "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": {
+ "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": {
+ "$ref": "OAuthRequirements",
+ "description": "The requirements for OAuth credentials."
+ },
+ "customAuth": {
+ "$ref": "CustomAuthRequirements",
+ "description": "Configuration for custom authentication."
+ }
+ },
+ "id": "AuthenticationRule"
+ },
+ "Api": {
+ "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",
+ "properties": {
+ "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": {
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of the service.",
"type": "string",
- "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive."
+ "enumDescriptions": [
+ "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"
+ }
+ }
+ }
+ },
+ "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": {
+ "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",
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "Page": {
+ "id": "Page",
+ "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "subpages": {
+ "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ }
+ }
+ },
+ "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": {
+ "details": {
+ "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."
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "type": "object",
+ "properties": {
+ "projectConfig": {
+ "$ref": "TenantProjectConfig",
+ "description": "Configuration of the new tenant project that will be added to tenancy unit\nresources."
+ },
+ "tag": {
+ "type": "string",
+ "description": "Tag of the added project. Must be less than 128 characters. Required."
+ }
+ },
+ "id": "AddTenantProjectRequest",
+ "description": "Request to add a newly created and configured tenant project to tenancy\nunit."
+ },
+ "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": {
+ "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": {
+ "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": {
+ "$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": {
+ "$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": {
+ "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"
+ }
+ },
+ "types": {
+ "type": "array",
+ "items": {
+ "$ref": "Type"
+ },
+ "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"
+ },
+ "sourceInfo": {
+ "$ref": "SourceInfo",
+ "description": "Output only. The source information for this configuration if available."
+ },
+ "http": {
+ "description": "HTTP configuration.",
+ "$ref": "Http"
+ },
+ "backend": {
+ "description": "API backend configuration.",
+ "$ref": "Backend"
+ },
+ "systemParameters": {
+ "$ref": "SystemParameters",
+ "description": "System parameter configuration."
+ },
+ "documentation": {
+ "$ref": "Documentation",
+ "description": "Additional API documentation."
+ }
+ },
+ "id": "Service"
+ },
+ "EnumValue": {
+ "id": "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"
+ }
+ }
+ }
+ },
+ "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": {
+ "kind": {
+ "description": "The name of this custom HTTP verb.",
+ "type": "string"
+ },
+ "path": {
+ "type": "string",
+ "description": "The path matched by this custom verb."
+ }
+ },
+ "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"
+ },
+ "TenantResource": {
+ "description": "Resource constituting the TenancyUnit.",
+ "type": "object",
+ "properties": {
+ "tag": {
+ "description": "Unique per single tenancy unit.",
+ "type": "string"
+ },
+ "resource": {
+ "type": "string",
+ "description": "@OutputOnly Identifier of the tenant resource.\nFor cloud projects it is in the form 'projects/{number}'.\nFor example 'projects/123456'."
+ },
+ "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"
+ },
+ "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": {
+ "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": {
+ "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"
+ },
+ "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": {
+ "$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."
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "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."
+ },
+ "monitoredResource": {
+ "type": "string",
+ "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section."
+ }
+ },
+ "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": {
+ "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",
+ "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"
+ },
+ "Quota": {
+ "properties": {
+ "limits": {
+ "description": "List of `QuotaLimit` definitions for the service.",
+ "type": "array",
+ "items": {
+ "$ref": "QuotaLimit"
+ }
+ },
+ "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"
+ },
+ "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": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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'"
+ },
+ "billingConfig": {
+ "$ref": "BillingConfig",
+ "description": "Billing account properties.\nIt may be specified explicitly, or created from the specified group\nduring provisioning"
+ },
+ "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": {
+ "description": "Labels that will be applied to this project.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "serviceAccountConfig": {
+ "$ref": "ServiceAccountConfig",
+ "description": "Configuration for IAM service account on tenant project."
+ }
+ },
+ "id": "TenantProjectConfig"
+ },
+ "PolicyBinding": {
+ "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",
+ "description": "Translates to IAM Policy bindings (without auditing at this level)",
+ "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": {
+ "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": {
+ "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",
+ "type": "object"
+ },
+ "QuotaLimit": {
+ "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`.",
+ "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": {
+ "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",
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "Method": {
+ "description": "Method represents a method of an API interface.",
+ "type": "object",
+ "properties": {
+ "responseStreaming": {
+ "type": "boolean",
+ "description": "If true, the response is streamed."
+ },
+ "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"
+ },
+ "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": {
+ "description": "The fully qualified name of the interface which is included.",
+ "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",
+ "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": {
+ "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"
+ }
+ }
+ },
+ "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": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ }
+ },
+ "id": "SourceInfo"
+ },
+ "Control": {
+ "id": "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"
+ }
+ }
+ },
+ "SystemParameter": {
+ "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": {
- "type": "string",
- "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive."
+ "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
+ "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."
+ "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"
},
"Field": {
"description": "A single field of a message type.",
@@ -463,7 +1509,6 @@
"type": "string"
},
"kind": {
- "type": "string",
"enumDescriptions": [
"Field type unknown.",
"Field type double.",
@@ -506,14 +1551,15 @@
"TYPE_SINT32",
"TYPE_SINT64"
],
- "description": "The field type."
+ "description": "The field type.",
+ "type": "string"
},
"options": {
+ "description": "The protocol buffer options.",
"type": "array",
"items": {
"$ref": "Option"
- },
- "description": "The protocol buffer options."
+ }
},
"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.",
@@ -521,6 +1567,7 @@
"type": "integer"
},
"cardinality": {
+ "description": "The field cardinality.",
"type": "string",
"enumDescriptions": [
"For fields with unknown cardinality.",
@@ -533,8 +1580,7 @@
"CARDINALITY_OPTIONAL",
"CARDINALITY_REQUIRED",
"CARDINALITY_REPEATED"
- ],
- "description": "The field cardinality."
+ ]
},
"packed": {
"description": "Whether to use alternative packed wire representation.",
@@ -549,8 +1595,8 @@
"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"
+ "type": "string",
+ "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`."
},
"number": {
"description": "The field number.",
@@ -561,116 +1607,100 @@
"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": {
- "producerDestinations": {
- "type": "array",
- "items": {
- "$ref": "MonitoringDestination"
- },
- "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."
- },
"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"
- },
- "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."
+ }
+ },
+ "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"
+ "id": "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"
},
"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": {
- "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"
- },
- "description": "Enum value definitions."
- }
- },
- "id": "Enum",
- "description": "Enum type definition."
- },
- "LabelDescriptor": {
- "type": "object",
- "properties": {
- "key": {
- "description": "The label key.",
- "type": "string"
+ }
},
- "description": {
- "description": "A human-readable description for the label.",
- "type": "string"
+ "options": {
+ "description": "Protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
},
- "valueType": {
- "type": "string",
- "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."
- }
- },
- "id": "LabelDescriptor",
- "description": "A description of a label."
- },
- "Type": {
- "description": "A protocol buffer message type.",
- "type": "object",
- "properties": {
"sourceContext": {
"$ref": "SourceContext",
"description": "The source context."
},
"syntax": {
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
],
"description": "The source syntax.",
+ "type": "string"
+ }
+ },
+ "id": "Enum"
+ },
+ "LabelDescriptor": {
+ "id": "LabelDescriptor",
+ "description": "A description of a label.",
+ "type": "object",
+ "properties": {
+ "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": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
+ "A variable-length string. This is the default.",
+ "Boolean; true or false.",
+ "A 64-bit signed integer."
]
},
+ "key": {
+ "description": "The label key.",
+ "type": "string"
+ }
+ }
+ },
+ "Type": {
+ "description": "A protocol buffer message type.",
+ "type": "object",
+ "properties": {
"options": {
"type": "array",
"items": {
@@ -686,15 +1716,31 @@
}
},
"name": {
- "type": "string",
- "description": "The fully qualified message 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"
- },
- "description": "The list of types appearing in `oneof` definitions in this type."
+ }
+ },
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "The source context."
+ },
+ "syntax": {
+ "description": "The source syntax.",
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ]
}
},
"id": "Type"
@@ -704,8 +1750,8 @@
"type": "object",
"properties": {
"authorization": {
- "$ref": "AuthorizationConfig",
- "description": "Authorization configuration."
+ "description": "Authorization configuration.",
+ "$ref": "AuthorizationConfig"
}
},
"id": "Experimental"
@@ -724,10 +1770,19 @@
},
"id": "Backend"
},
- "ServiceAccountConfig": {
- "description": "Describes service account configuration for the tenant project.",
+ "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",
"properties": {
+ "provider": {
+ "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
+ "type": "string"
+ }
+ },
+ "id": "AuthorizationConfig"
+ },
+ "ServiceAccountConfig": {
+ "properties": {
"tenantProjectRoles": {
"description": "Roles for the service account above on tenant project.",
"type": "array",
@@ -736,109 +1791,73 @@
}
},
"accountId": {
- "type": "string",
- "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."
- }
- },
- "id": "ServiceAccountConfig"
- },
- "AuthorizationConfig": {
- "type": "object",
- "properties": {
- "provider": {
- "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
+ "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": "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"
+ "id": "ServiceAccountConfig",
+ "description": "Describes service account configuration for the tenant project.",
+ "type": "object"
},
"DocumentationRule": {
+ "id": "DocumentationRule",
"description": "A documentation rule provides information about individual API elements.",
"type": "object",
"properties": {
"deprecationDescription": {
- "type": "string",
- "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`."
+ "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"
},
"description": {
- "type": "string",
- "description": "Description of the selected API(s)."
+ "description": "Description of the selected API(s).",
+ "type": "string"
}
- },
- "id": "DocumentationRule"
+ }
},
"ContextRule": {
+ "description": "A context rule provides information about the context for an individual API\nelement.",
"type": "object",
"properties": {
- "provided": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "A list of full type names of provided contexts."
- },
"requested": {
+ "description": "A list of full type names of requested contexts.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "A list of full type names of requested contexts."
+ }
},
"selector": {
- "type": "string",
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details."
- }
- },
- "id": "ContextRule",
- "description": "A context rule provides information about the context for an individual API\nelement."
- },
- "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": {
- "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.",
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "provided": {
+ "description": "A list of full type names of provided contexts.",
"type": "array",
"items": {
- "$ref": "BillingDestination"
+ "type": "string"
}
}
},
- "id": "Billing"
+ "id": "ContextRule"
+ },
+ "SourceContext": {
+ "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
+ "type": "object",
+ "properties": {
+ "fileName": {
+ "type": "string",
+ "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`."
+ }
+ },
+ "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": {
- "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": {
- "type": "string",
- "description": "A detailed description of the metric, which can be used in documentation."
- },
"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"
@@ -859,6 +1878,15 @@
"type": "string"
},
"valueType": {
+ "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`.",
+ "The value is a signed 64-bit integer.",
+ "The value is a double precision floating point number.",
+ "The value is a text string.\nThis 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",
@@ -869,50 +1897,50 @@
"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",
+ "type": "string"
+ },
+ "metricKind": {
"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`.",
- "The value is a signed 64-bit integer.",
- "The value is a double precision floating point number.",
- "The value is a text string.\nThis value type can be used only if the metric kind is `GAUGE`.",
- "The value is a `Distribution`.",
- "The value is money."
- ]
+ "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"
}
},
"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": {
- "type": "string",
- "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`."
- }
- },
- "id": "SourceContext"
- },
- "SearchTenancyUnitsResponse": {
- "description": "Response for the search query.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token for large results."
- },
- "tenancyUnits": {
- "description": "Tenancy Units matching the request.",
+ "consumerDestinations": {
"type": "array",
"items": {
- "$ref": "TenancyUnit"
- }
+ "$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": "SearchTenancyUnitsResponse"
+ "id": "Billing"
},
- "ListTenancyUnitsResponse": {
+ "SearchTenancyUnitsResponse": {
"type": "object",
"properties": {
"nextPageToken": {
@@ -927,19 +1955,45 @@
}
}
},
+ "id": "SearchTenancyUnitsResponse",
+ "description": "Response for the search query."
+ },
+ "ListTenancyUnitsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "Pagination token for large results.",
+ "type": "string"
+ },
+ "tenancyUnits": {
+ "type": "array",
+ "items": {
+ "$ref": "TenancyUnit"
+ },
+ "description": "Tenancy Units matching the request."
+ }
+ },
"id": "ListTenancyUnitsResponse",
- "description": "Response for the list request."
+ "description": "Response for the list request.",
+ "type": "object"
},
"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": {
+ "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.",
@@ -949,45 +2003,37 @@
}
},
"allowCors": {
- "type": "boolean",
- "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."
- },
- "name": {
- "type": "string",
- "description": "The canonical name of this endpoint."
- },
- "target": {
- "type": "string",
- "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\"."
+ "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"
},
"OAuthRequirements": {
- "type": "object",
"properties": {
"canonicalScopes": {
- "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"
+ "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"
}
},
"id": "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."
+ "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"
},
"Usage": {
"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."
+ "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"
- },
- "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'.",
@@ -1014,18 +2060,13 @@
"id": "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"
- }
- },
"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": {
"description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
@@ -1034,110 +2075,115 @@
"displayName": {
"description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
"type": "string"
- }
- },
- "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"
- },
- "CustomErrorRule": {
- "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": {
- "type": "string",
- "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details."
- }
- },
- "id": "CustomErrorRule",
- "description": "A custom error rule."
- },
- "MonitoredResourceDescriptor": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "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."
},
"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": "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\"`."
+ }
+ }
+ }
+ },
+ "CustomErrorRule": {
+ "description": "A custom error rule.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "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"
},
"displayName": {
- "type": "string",
- "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\"`."
+ "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": {
- "type": "string",
- "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation."
+ "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"
}
},
- "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."
+ "id": "MonitoredResourceDescriptor"
+ },
+ "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": {
+ "useDirectDownload": {
+ "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
+ "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"
+ },
+ "completeNotification": {
+ "type": "boolean",
+ "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend."
+ },
+ "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"
+ }
+ },
+ "id": "MediaDownload"
},
"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": {
- "enabled": {
- "description": "Whether download is enabled.",
- "type": "boolean"
- },
- "downloadService": {
- "type": "string",
- "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."
- },
- "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": {
- "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"
- }
- },
- "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": {
- "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"
+ },
+ "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"
@@ -1146,55 +2192,55 @@
"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": {
- "type": "boolean",
- "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."
+ "mimeTypes": {
+ "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "progressNotification": {
- "description": "Whether to receive a notification for progress changes of media upload.",
- "type": "boolean"
+ "maxSize": {
+ "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
+ "format": "int64",
+ "type": "string"
},
"enabled": {
"description": "Whether upload is enabled.",
"type": "boolean"
},
+ "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"
+ },
"dropzone": {
- "type": "string",
- "description": "Name of the Scotty dropzone to use for the current API."
+ "description": "Name of the Scotty dropzone to use for the current API.",
+ "type": "string"
},
"startNotification": {
- "type": "boolean",
- "description": "Whether to receive a notification on the start of media upload."
+ "description": "Whether to receive a notification on the start of media upload.",
+ "type": "boolean"
},
"uploadService": {
- "type": "string",
- "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."
- },
- "maxSize": {
- "type": "string",
- "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
- "format": "int64"
- },
- "mimeTypes": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns."
+ "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"
},
"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"
+ "type": "string",
+ "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."
}
},
- "id": "CreateTenancyUnitRequest"
+ "id": "CreateTenancyUnitRequest",
+ "description": "Request to create a tenancy unit for a consumer of a service.",
+ "type": "object"
},
"BillingDestination": {
"description": "Configuration of a specific billing destination (Currently only support\nbill against consumer project).",
@@ -1205,36 +2251,36 @@
"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"
- },
- "description": "Names of the metrics to report to this billing destination.\nEach name must be defined in Service.metrics section."
+ }
}
},
"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"
+ "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 `{}`."
},
"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": {
+ "allowUnregisteredCalls": {
+ "description": "If true, the selected method allows unregistered calls, e.g. calls\nthat don't identify any user or application.",
+ "type": "boolean"
+ },
"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": {
- "type": "boolean",
- "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."
- },
- "allowUnregisteredCalls": {
- "type": "boolean",
- "description": "If true, the selected method allows unregistered calls, e.g. calls\nthat don't identify any user or application."
+ "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"
}
},
"id": "UsageRule"
@@ -1244,8 +2290,8 @@
"type": "object",
"properties": {
"audiences": {
- "type": "string",
- "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"
+ "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",
@@ -1255,6 +2301,7 @@
"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": {
@@ -1273,8 +2320,8 @@
}
},
"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."
+ "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.",
@@ -1284,1067 +2331,14 @@
}
}
},
- "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."
- },
- "BackendRule": {
- "description": "A backend rule provides configuration for an individual API element.",
- "type": "object",
- "properties": {
- "address": {
- "description": "The address of the API backend.",
- "type": "string"
- },
- "selector": {
- "type": "string",
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details."
- },
- "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": {
- "type": "number",
- "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
- "format": "double"
- }
- },
- "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": {
- "type": "string",
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details."
- },
- "allowWithoutCredential": {
- "type": "boolean",
- "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."
- }
- },
- "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": {
- "type": "array",
- "items": {
- "$ref": "Method"
- },
- "description": "The methods of this interface, in unspecified order."
- },
- "name": {
- "type": "string",
- "description": "The fully qualified name of this interface, including package name\nfollowed by the interface's simple name."
- },
- "syntax": {
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax of the service."
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "Source context for the protocol buffer service represented by this\nmessage."
- },
- "version": {
- "type": "string",
- "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"
- },
- "mixins": {
- "type": "array",
- "items": {
- "$ref": "Mixin"
- },
- "description": "Included interfaces. See Mixin."
- }
- },
- "id": "Api"
- },
- "CancelOperationRequest": {
- "type": "object",
- "properties": {},
- "id": "CancelOperationRequest",
- "description": "The request message for Operations.CancelOperation."
- },
- "MetricRule": {
- "type": "object",
- "properties": {
- "selector": {
- "type": "string",
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details."
- },
- "metricCosts": {
- "type": "object",
- "additionalProperties": {
- "type": "string",
- "format": "int64"
- },
- "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."
- }
- },
- "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."
- },
- "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": {
- "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"
- }
- }
- },
- "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": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "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."
- },
- "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."
- }
- },
- "id": "Operation"
- },
- "Page": {
- "type": "object",
- "properties": {
- "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": {
- "type": "string",
- "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file."
- },
- "subpages": {
- "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
- "type": "array",
- "items": {
- "$ref": "Page"
- }
- }
- },
- "id": "Page",
- "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure."
- },
- "Status": {
- "type": "object",
- "properties": {
- "details": {
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- }
- },
- "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use."
- },
- "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",
- "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."
- },
- "AuthProvider": {
- "type": "object",
- "properties": {
- "audiences": {
- "type": "string",
- "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"
- },
- "id": {
- "type": "string",
- "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\"."
- },
- "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"
- },
- "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",
- "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)."
- },
- "AddTenantProjectRequest": {
- "type": "object",
- "properties": {
- "projectConfig": {
- "$ref": "TenantProjectConfig",
- "description": "Configuration of the new tenant project that will be added to tenancy unit\nresources."
- },
- "tag": {
- "description": "Tag of the added project. Must be less than 128 characters. Required.",
- "type": "string"
- }
- },
- "id": "AddTenantProjectRequest",
- "description": "Request to add a newly created and configured tenant project to tenancy\nunit."
- },
- "Service": {
- "type": "object",
- "properties": {
- "documentation": {
- "$ref": "Documentation",
- "description": "Additional API documentation."
- },
- "logging": {
- "$ref": "Logging",
- "description": "Logging configuration."
- },
- "monitoredResources": {
- "type": "array",
- "items": {
- "$ref": "MonitoredResourceDescriptor"
- },
- "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations."
- },
- "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": {
- "$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."
- },
- "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": {
- "type": "string",
- "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`."
- },
- "billing": {
- "$ref": "Billing",
- "description": "Billing configuration."
- },
- "customError": {
- "$ref": "CustomError",
- "description": "Custom error configuration."
- },
- "title": {
- "type": "string",
- "description": "The product title for this service."
- },
- "endpoints": {
- "type": "array",
- "items": {
- "$ref": "Endpoint"
- },
- "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."
- },
- "logs": {
- "type": "array",
- "items": {
- "$ref": "LogDescriptor"
- },
- "description": "Defines the logs used by this service."
- },
- "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": {
- "type": "array",
- "items": {
- "$ref": "Type"
- },
- "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"
- },
- "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": {
- "$ref": "Backend",
- "description": "API backend configuration."
- }
- },
- "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": {
- "description": "Enum value definition.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Enum value name.",
- "type": "string"
- },
- "options": {
- "type": "array",
- "items": {
- "$ref": "Option"
- },
- "description": "Protocol buffer options."
- },
- "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": {
- "type": "string",
- "description": "The standard List next-page token."
- }
- },
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations."
- },
- "CustomHttpPattern": {
- "type": "object",
- "properties": {
- "kind": {
- "type": "string",
- "description": "The name of this custom HTTP verb."
- },
- "path": {
- "type": "string",
- "description": "The path matched by this custom verb."
- }
- },
- "id": "CustomHttpPattern",
- "description": "A custom pattern is used for defining custom HTTP verb."
- },
- "SystemParameterRule": {
- "type": "object",
- "properties": {
- "selector": {
- "type": "string",
- "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details."
- },
- "parameters": {
- "type": "array",
- "items": {
- "$ref": "SystemParameter"
- },
- "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."
- }
- },
- "id": "SystemParameterRule",
- "description": "Define a system parameter rule mapping system parameter definitions to\nmethods."
- },
- "BillingConfig": {
- "description": "Describes billing configuration for new a Tenant Project",
- "type": "object",
- "properties": {
- "billingAccount": {
- "type": "string",
- "description": "Name of the billing account.\nFor example `billingAccounts/012345-567890-ABCDEF`."
- }
- },
- "id": "BillingConfig"
- },
- "TenantResource": {
- "description": "Resource constituting the TenancyUnit.",
- "type": "object",
- "properties": {
- "resource": {
- "type": "string",
- "description": "@OutputOnly Identifier of the tenant resource.\nFor cloud projects it is in the form 'projects/{number}'.\nFor example 'projects/123456'."
- },
- "status": {
- "enum": [
- "STATUS_UNSPECIFIED",
- "PENDING_CREATE",
- "ACTIVE",
- "PENDING_DELETE",
- "FAILED"
- ],
- "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."
- ]
- },
- "tag": {
- "type": "string",
- "description": "Unique per single tenancy unit."
- }
- },
- "id": "TenantResource"
- },
- "RemoveTenantProjectRequest": {
- "type": "object",
- "properties": {
- "tag": {
- "type": "string",
- "description": "Tag of the resource within the tenancy unit."
- }
- },
- "id": "RemoveTenantProjectRequest",
- "description": "Request message to remove tenant project resource from the tenancy unit."
- },
- "HttpRule": {
- "type": "object",
- "properties": {
- "restMethodName": {
- "type": "string",
- "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."
- },
- "additionalBindings": {
- "type": "array",
- "items": {
- "$ref": "HttpRule"
- },
- "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)."
- },
- "restCollection": {
- "type": "string",
- "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."
- },
- "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."
- },
- "selector": {
- "type": "string",
- "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details."
- },
- "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": {
- "type": "string",
- "description": "Used for updating a resource."
- },
- "get": {
- "type": "string",
- "description": "Used for listing and getting information about resources."
- },
- "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": {
- "$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": {
- "type": "string",
- "description": "Used for creating a resource."
- }
- },
- "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."
- },
- "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": {
- "type": "string",
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section."
- }
- },
- "id": "MonitoringDestination"
- },
- "TenancyUnit": {
- "description": "Representation of a tenancy unit.",
- "type": "object",
- "properties": {
- "service": {
- "type": "string",
- "description": "@OutputOnly Google Cloud API name of the service owning this tenancy unit.\nFor example 'serviceconsumermanagement.googleapis.com'."
- },
- "name": {
- "type": "string",
- "description": "Globally unique identifier of this tenancy unit\n\"services/{service}/{collection id}/{resource id}/tenancyUnits/{unit}\""
- },
- "tenantResources": {
- "description": "Resources constituting the tenancy unit.",
- "type": "array",
- "items": {
- "$ref": "TenantResource"
- }
- },
- "consumer": {
- "type": "string",
- "description": "@OutputOnly Cloud resource One Platform Name of the consumer of this\nservice. For example 'projects/123456'."
- },
- "createTime": {
- "description": "@OutputOnly The time this tenancy unit was created.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "TenancyUnit"
- },
- "Visibility": {
- "type": "object",
- "properties": {
- "rules": {
- "type": "array",
- "items": {
- "$ref": "VisibilityRule"
- },
- "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order."
- }
- },
- "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."
- },
- "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": {
- "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",
- "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"
- },
- "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": {
- "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": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "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}`."
- },
- "role": {
- "type": "string",
- "description": "Role. (https://cloud.google.com/iam/docs/understanding-roles)\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`."
- }
- },
- "id": "PolicyBinding"
- },
- "LoggingDestination": {
- "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": {
- "type": "string",
- "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section."
- }
- },
- "id": "LoggingDestination",
- "description": "Configuration of a specific logging destination (the producer project\nor the consumer project)."
- },
- "Option": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "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\"`."
- },
- "value": {
- "type": "object",
- "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."
- }
- },
- "id": "Option",
- "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc."
- },
- "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": {
- "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"
- }
- },
- "consumerDestinations": {
- "type": "array",
- "items": {
- "$ref": "LoggingDestination"
- },
- "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."
- }
- },
- "id": "Logging"
- },
- "QuotaLimit": {
- "type": "object",
- "properties": {
- "values": {
- "type": "object",
- "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."
- },
- "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"
- },
- "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": {
- "type": "string",
- "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."
- },
- "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": {
- "type": "string",
- "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"
- },
- "description": {
- "type": "string",
- "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`)."
- },
- "metric": {
- "type": "string",
- "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."
- },
- "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."
- }
- },
- "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`."
- },
- "Method": {
- "description": "Method represents a method of an API interface.",
- "type": "object",
- "properties": {
- "requestStreaming": {
- "type": "boolean",
- "description": "If true, the request is streamed."
- },
- "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": {
- "type": "array",
- "items": {
- "$ref": "Option"
- },
- "description": "Any metadata attached to the method."
- },
- "responseStreaming": {
- "description": "If true, the response is streamed.",
- "type": "boolean"
- },
- "name": {
- "type": "string",
- "description": "The simple name of this method."
- },
- "requestTypeUrl": {
- "type": "string",
- "description": "A URL of the input message type."
- }
- },
- "id": "Method"
- },
- "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": {
- "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"
- },
- "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": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'."
- },
- "rules": {
- "type": "array",
- "items": {
- "$ref": "CustomErrorRule"
- },
- "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."
- }
- },
- "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.",
- "type": "object",
- "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"
- },
- "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": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "type": "object"
- }
- }
- },
- "id": "SourceInfo"
- },
- "Control": {
- "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",
- "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc."
+ "id": "Documentation"
}
},
- "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": "Service Consumer Management",
"auth": {
"oauth2": {
@@ -2358,5 +2352,11 @@
}
}
},
- "rootUrl": "https://serviceconsumermanagement.googleapis.com/"
+ "rootUrl": "https://serviceconsumermanagement.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "serviceconsumermanagement",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Service Consumer Management API",
+ "ownerName": "Google"
}
diff --git a/servicecontrol/v1/servicecontrol-api.json b/servicecontrol/v1/servicecontrol-api.json
index 8fafdcb..e900402 100644
--- a/servicecontrol/v1/servicecontrol-api.json
+++ b/servicecontrol/v1/servicecontrol-api.json
@@ -1,573 +1,292 @@
{
+ "fullyEncodeReservedExpansion": true,
+ "title": "Google Service Control API",
+ "ownerName": "Google",
+ "resources": {
+ "services": {
+ "methods": {
+ "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).",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "StartReconciliationResponse"
+ },
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "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"
+ }
+ },
+ "scopes": [
+ "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"
+ },
+ "check": {
+ "response": {
+ "$ref": "CheckResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:check",
+ "path": "v1/services/{serviceName}:check",
+ "id": "servicecontrol.services.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"
+ }
+ },
+ "releaseQuota": {
+ "response": {
+ "$ref": "ReleaseQuotaResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "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"
+ }
+ },
+ "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"
+ }
+ },
+ "endReconciliation": {
+ "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).",
+ "request": {
+ "$ref": "EndReconciliationRequest"
+ },
+ "response": {
+ "$ref": "EndReconciliationResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "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"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:endReconciliation",
+ "path": "v1/services/{serviceName}:endReconciliation",
+ "id": "servicecontrol.services.endReconciliation"
+ },
+ "report": {
+ "path": "v1/services/{serviceName}:report",
+ "id": "servicecontrol.services.report",
+ "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).",
+ "request": {
+ "$ref": "ReportRequest"
+ },
+ "response": {
+ "$ref": "ReportResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:report"
+ },
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "AllocateQuotaResponse"
+ },
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "flatPath": "v1/services/{serviceName}:allocateQuota",
+ "id": "servicecontrol.services.allocateQuota",
+ "path": "v1/services/{serviceName}:allocateQuota"
+ }
+ }
+ }
+ },
+ "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": {
+ "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": {
+ "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": {
+ "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://servicecontrol.googleapis.com/",
+ "servicePath": "",
+ "kind": "discovery#restDescription",
+ "description": "Google Service Control provides control plane functionality to managed services, such as logging, monitoring, and status checks.",
+ "basePath": "",
+ "id": "servicecontrol:v1",
+ "documentationLink": "https://cloud.google.com/service-control/",
+ "revision": "20171211",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "QuotaOperation": {
- "description": "Represents information regarding a quota operation.",
- "type": "object",
- "properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels describing the operation.",
- "type": "object"
- },
- "consumerId": {
- "description": "Identity of the consumer for whom this quota operation is being performed.\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.",
- "type": "string"
- },
- "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"
- },
- "EndReconciliationRequest": {
- "id": "EndReconciliationRequest",
- "description": "Request message for QuotaController.EndReconciliation.",
- "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"
- }
- }
- },
- "ReportInfo": {
- "description": "Contains additional info about the report operation.",
- "type": "object",
- "properties": {
- "operationId": {
- "description": "The Operation.operation_id value from the request.",
- "type": "string"
- },
- "quotaInfo": {
- "description": "Quota usage info when processing the `Operation`.",
- "$ref": "QuotaInfo"
- }
- },
- "id": "ReportInfo"
- },
- "ReportResponse": {
- "id": "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.",
- "type": "array",
- "items": {
- "$ref": "ReportError"
- }
- },
- "reportInfos": {
- "description": "Quota usage for each quota release `Operation` request.\n\nFully or partially failed quota release request may or may not be present\nin `report_quota_info`. For example, a failed quota release request will\nhave the current quota usage info when precise quota library returns the\ninfo. A deadline exceeded quota request will not have quota usage info.\n\nIf there is no quota release request, report_quota_info will be empty.\n",
- "type": "array",
- "items": {
- "$ref": "ReportInfo"
- }
- },
- "serviceConfigId": {
- "description": "The actual config id used to process the request.",
- "type": "string"
- }
- }
- },
- "Operation": {
- "id": "Operation",
- "description": "Represents information regarding an operation.",
- "type": "object",
- "properties": {
- "operationName": {
- "description": "Fully qualified name of the operation. Reserved for future use.",
- "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"
- },
- "startTime": {
- "description": "Required. Start time of the operation.",
- "format": "google-datetime",
- "type": "string"
- },
- "importance": {
- "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."
- ],
- "enum": [
- "LOW",
- "HIGH",
- "DEBUG"
- ]
- },
- "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": {
- "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).",
- "type": "object"
- },
- "resources": {
- "description": "The resources that are involved in the operation.",
- "type": "array",
- "items": {
- "$ref": "ResourceInfo"
- }
- },
- "logEntries": {
- "description": "Represents information to be logged.",
- "type": "array",
- "items": {
- "$ref": "LogEntry"
- }
- },
- "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"
- }
- },
- "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.",
- "type": "array",
- "items": {
- "$ref": "MetricValueSet"
- }
- },
- "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.",
- "type": "string"
- },
- "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"
- }
- }
- },
- "CheckResponse": {
- "id": "CheckResponse",
- "description": "Response message for the Check method.",
- "type": "object",
- "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": {
- "description": "Quota information for the check request associated with this response.\n",
- "$ref": "QuotaInfo"
- },
- "serviceConfigId": {
- "description": "The actual config id used to process the request.",
- "type": "string"
- }
- }
- },
- "AllocateInfo": {
- "id": "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"
- }
- }
- }
- },
- "ReportRequest": {
- "id": "ReportRequest",
- "description": "Request message for the Report method.",
- "type": "object",
- "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"
- }
- },
- "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"
- }
- }
- },
- "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"
- },
- "LogEntry": {
- "description": "An individual log entry.",
- "type": "object",
- "properties": {
- "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": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.",
- "type": "object"
- },
- "severity": {
- "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."
- ],
- "enum": [
- "DEFAULT",
- "DEBUG",
- "INFO",
- "NOTICE",
- "WARNING",
- "ERROR",
- "CRITICAL",
- "ALERT",
- "EMERGENCY"
- ]
- },
- "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"
- }
- },
- "id": "LogEntry"
- },
- "AuditLog": {
- "id": "AuditLog",
- "description": "Common audit log format for Google Cloud Platform API operations.\n\n",
- "type": "object",
- "properties": {
- "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"
- },
- "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",
- "items": {
- "$ref": "AuthorizationInfo"
- }
- },
- "request": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "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": {
- "description": "Metadata about the operation.",
- "$ref": "RequestMetadata"
- },
- "authenticationInfo": {
- "$ref": "AuthenticationInfo",
- "description": "Authentication information."
- },
- "status": {
- "$ref": "Status",
- "description": "The status of the overall operation."
- },
- "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"
- }
- }
- },
- "MetricValue": {
- "id": "MetricValue",
- "description": "Represents a single metric value.",
- "type": "object",
- "properties": {
- "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"
- },
- "doubleValue": {
- "description": "A double precision floating point value.",
- "format": "double",
- "type": "number"
- },
- "int64Value": {
- "description": "A signed 64-bit integer value.",
- "format": "int64",
- "type": "string"
- },
- "distributionValue": {
- "description": "A distribution value.",
- "$ref": "Distribution"
- },
- "boolValue": {
- "description": "A boolean value.",
- "type": "boolean"
- },
- "endTime": {
- "description": "The end of the time period over which this metric value's measurement\napplies.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "The start of the time period over which this metric value's measurement\napplies. The time period has different semantics for different metric\ntypes (cumulative, delta, and gauge). See the metric definition\ndocumentation in the service configuration for details.",
- "format": "google-datetime",
- "type": "string"
- },
- "moneyValue": {
- "$ref": "Money",
- "description": "A money value."
- }
- }
- },
- "Money": {
- "id": "Money",
- "description": "Represents an amount of money with its currency type.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- }
- }
- },
- "EndReconciliationResponse": {
- "id": "EndReconciliationResponse",
- "description": "Response message for QuotaController.EndReconciliation.",
- "type": "object",
- "properties": {
- "operationId": {
- "description": "The same operation_id value used in the EndReconciliationRequest. Used for\nlogging and diagnostics purposes.",
- "type": "string"
- },
- "reconciliationErrors": {
- "description": "Indicates the decision of the reconciliation end.",
- "type": "array",
- "items": {
- "$ref": "QuotaError"
- }
- },
- "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",
- "items": {
- "$ref": "MetricValueSet"
- }
- }
- }
- },
- "ExplicitBuckets": {
- "id": "ExplicitBuckets",
- "description": "Describing buckets with arbitrary user-provided width.",
- "type": "object",
- "properties": {
- "bounds": {
- "description": "'bound' is a list of strictly increasing boundaries between\nbuckets. Note that a list of length N-1 defines N buckets because\nof fenceposting. See comments on `bucket_options` for details.\n\nThe i'th finite bucket covers the interval\n [bound[i-1], bound[i])\nwhere i ranges from 1 to bound_size() - 1. Note that there are no\nfinite buckets at all if 'bound' only contains a single element; in\nthat special case the single bound defines the boundary between the\nunderflow and overflow buckets.\n\nbucket number lower bound upper bound\n i == 0 (underflow) -inf bound[i]\n 0 \u003c i \u003c bound_size() bound[i-1] bound[i]\n i == bound_size() (overflow) bound[i-1] +inf",
- "type": "array",
- "items": {
- "format": "double",
- "type": "number"
- }
- }
- }
- },
"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",
"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": {
- "$ref": "LinearBuckets",
- "description": "Buckets with constant width."
+ "description": "Buckets with constant width.",
+ "$ref": "LinearBuckets"
},
"minimum": {
"description": "The minimum of the population of values. Ignored if `count` is zero.",
@@ -591,12 +310,40 @@
"format": "int64",
"type": "string"
}
+ },
+ "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"
}
},
"id": "Distribution"
},
+ "ExplicitBuckets": {
+ "description": "Describing buckets with arbitrary user-provided width.",
+ "type": "object",
+ "properties": {
+ "bounds": {
+ "description": "'bound' is a list of strictly increasing boundaries between\nbuckets. Note that a list of length N-1 defines N buckets because\nof fenceposting. See comments on `bucket_options` for details.\n\nThe i'th finite bucket covers the interval\n [bound[i-1], bound[i])\nwhere i ranges from 1 to bound_size() - 1. Note that there are no\nfinite buckets at all if 'bound' only contains a single element; in\nthat special case the single bound defines the boundary between the\nunderflow and overflow buckets.\n\nbucket number lower bound upper bound\n i == 0 (underflow) -inf bound[i]\n 0 \u003c i \u003c bound_size() bound[i-1] bound[i]\n i == bound_size() (overflow) bound[i-1] +inf",
+ "type": "array",
+ "items": {
+ "format": "double",
+ "type": "number"
+ }
+ }
+ },
+ "id": "ExplicitBuckets"
+ },
"ExponentialBuckets": {
- "id": "ExponentialBuckets",
"description": "Describing buckets with exponentially growing width.",
"type": "object",
"properties": {
@@ -615,12 +362,10 @@
"format": "double",
"type": "number"
}
- }
+ },
+ "id": "ExponentialBuckets"
},
"AuthorizationInfo": {
- "id": "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",
@@ -634,10 +379,12 @@
"description": "The required IAM permission.",
"type": "string"
}
- }
+ },
+ "id": "AuthorizationInfo",
+ "description": "Authorization information for the operation.",
+ "type": "object"
},
"ResourceInfo": {
- "id": "ResourceInfo",
"description": "Describes a resource associated with this operation.",
"type": "object",
"properties": {
@@ -649,11 +396,10 @@
"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"
}
- }
+ },
+ "id": "ResourceInfo"
},
"StartReconciliationResponse": {
- "description": "Response message for QuotaController.StartReconciliation.",
- "type": "object",
"properties": {
"operationId": {
"description": "The same operation_id value used in the StartReconciliationRequest. Used\nfor logging and diagnostics purposes.",
@@ -678,14 +424,21 @@
}
}
},
- "id": "StartReconciliationResponse"
+ "id": "StartReconciliationResponse",
+ "description": "Response message for QuotaController.StartReconciliation.",
+ "type": "object"
},
"QuotaProperties": {
- "id": "QuotaProperties",
"description": "Represents the properties needed for quota operations.",
"type": "object",
"properties": {
"quotaMode": {
+ "enum": [
+ "ACQUIRE",
+ "ACQUIRE_BEST_EFFORT",
+ "CHECK",
+ "RELEASE"
+ ],
"description": "Quota mode for this operation.",
"type": "string",
"enumDescriptions": [
@@ -693,25 +446,15 @@
"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.",
"Does not change any available quota. Only checks if there is enough\nquota.\nNo lock is placed on the checked tokens neither.",
"Increases available quota by the operation cost specified for the\noperation."
- ],
- "enum": [
- "ACQUIRE",
- "ACQUIRE_BEST_EFFORT",
- "CHECK",
- "RELEASE"
]
}
- }
+ },
+ "id": "QuotaProperties"
},
"LinearBuckets": {
"description": "Describing buckets with constant width.",
"type": "object",
"properties": {
- "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"
- },
"width": {
"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",
@@ -721,6 +464,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.",
"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": "LinearBuckets"
@@ -738,12 +486,12 @@
"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"
@@ -752,6 +500,13 @@
"description": "Response message for the AllocateQuota method.",
"type": "object",
"properties": {
+ "allocateErrors": {
+ "description": "Indicates the decision of the allocate.",
+ "type": "array",
+ "items": {
+ "$ref": "QuotaError"
+ }
+ },
"quotaMetrics": {
"description": "Quota metrics to indicate the result of allocation. Depending on the\nrequest, one or more of the following metrics will be included:\n\n1. Per quota group or per quota metric incremental usage will be specified\nusing the following delta metric :\n \"serviceruntime.googleapis.com/api/consumer/quota_used_count\"\n\n2. The quota limit reached condition will be specified using the following\nboolean metric :\n \"serviceruntime.googleapis.com/quota/exceeded\"",
"type": "array",
@@ -768,22 +523,13 @@
"type": "string"
},
"allocateInfo": {
- "description": "WARNING: DO NOT use this field until this warning message is removed.",
- "$ref": "AllocateInfo"
- },
- "allocateErrors": {
- "description": "Indicates the decision of the allocate.",
- "type": "array",
- "items": {
- "$ref": "QuotaError"
- }
+ "$ref": "AllocateInfo",
+ "description": "WARNING: DO NOT use this field until this warning message is removed."
}
},
"id": "AllocateQuotaResponse"
},
"ReleaseQuotaRequest": {
- "description": "Request message for the ReleaseQuota 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.",
@@ -794,7 +540,28 @@
"$ref": "QuotaOperation"
}
},
- "id": "ReleaseQuotaRequest"
+ "id": "ReleaseQuotaRequest",
+ "description": "Request message for the ReleaseQuota method.",
+ "type": "object"
+ },
+ "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"
},
"QuotaError": {
"description": "Represents error information for QuotaOperation.",
@@ -809,8 +576,6 @@
"type": "string"
},
"code": {
- "description": "Error code.",
- "type": "string",
"enumDescriptions": [
"This is never used.",
"Quota allocation failed.\nSame as google.rpc.Code.RESOURCE_EXHAUSTED.",
@@ -842,30 +607,13 @@
"SERVICE_STATUS_UNAVAILABLE",
"BILLING_STATUS_UNAVAILABLE",
"QUOTA_SYSTEM_UNAVAILABLE"
- ]
+ ],
+ "description": "Error code.",
+ "type": "string"
}
},
"id": "QuotaError"
},
- "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"
- },
"CheckInfo": {
"description": "Contains additional information about the check operation.",
"type": "object",
@@ -884,10 +632,23 @@
},
"id": "CheckInfo"
},
- "ReleaseQuotaResponse": {
- "description": "Response message for the ReleaseQuota method.",
+ "AllocateQuotaRequest": {
+ "description": "Request message for the AllocateQuota method.",
"type": "object",
"properties": {
+ "allocateOperation": {
+ "description": "Operation that describes the quota allocation.",
+ "$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": "AllocateQuotaRequest"
+ },
+ "ReleaseQuotaResponse": {
+ "properties": {
"operationId": {
"description": "The same operation_id value used in the ReleaseQuotaRequest. Used for\nlogging and diagnostics purposes.",
"type": "string"
@@ -911,37 +672,24 @@
}
}
},
- "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"
+ "id": "ReleaseQuotaResponse",
+ "description": "Response message for the ReleaseQuota method.",
+ "type": "object"
},
"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"
@@ -950,13 +698,13 @@
"description": "Represents the processing error of one Operation in the request.",
"type": "object",
"properties": {
- "status": {
- "description": "Details of the error when processing the Operation.",
- "$ref": "Status"
- },
"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"
@@ -965,13 +713,13 @@
"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"
+ },
+ "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"
@@ -985,8 +733,6 @@
"type": "string"
},
"code": {
- "description": "The error code.",
- "type": "string",
"enumDescriptions": [
"This is never used in `CheckResponse`.",
"The consumer's project id was not found.\nSame as google.rpc.Code.NOT_FOUND.",
@@ -1054,16 +800,24 @@
"LOAS_PROJECT_LOOKUP_UNAVAILABLE",
"CLOUD_RESOURCE_MANAGER_BACKEND_UNAVAILABLE",
"SECURITY_POLICY_BACKEND_UNAVAILABLE"
- ]
+ ],
+ "description": "The error code.",
+ "type": "string"
}
},
"id": "CheckError"
},
"QuotaInfo": {
- "id": "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": {
"additionalProperties": {
"format": "int32",
@@ -1078,18 +832,11 @@
"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"
},
"ConsumerInfo": {
- "id": "ConsumerInfo",
"description": "`ConsumerInfo` provides information about the consumer project.",
"type": "object",
"properties": {
@@ -1098,15 +845,18 @@
"format": "int64",
"type": "string"
}
- }
+ },
+ "id": "ConsumerInfo"
},
"CheckRequest": {
- "description": "Request message for the Check method.",
- "type": "object",
"properties": {
+ "skipActivationCheck": {
+ "description": "Indicates if service activation check should be skipped for this request.\nDefault behavior is to perform the check and apply relevant quota.",
+ "type": "boolean"
+ },
"operation": {
- "description": "The operation to be checked.",
- "$ref": "Operation"
+ "$ref": "Operation",
+ "description": "The operation to be checked."
},
"requestProjectSettings": {
"description": "Requests the project settings to be returned as part of the check response.",
@@ -1115,20 +865,544 @@
"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.",
"type": "string"
- },
- "skipActivationCheck": {
- "description": "Indicates if service activation check should be skipped for this request.\nDefault behavior is to perform the check and apply relevant quota.",
- "type": "boolean"
}
},
- "id": "CheckRequest"
+ "id": "CheckRequest",
+ "description": "Request message for the Check method.",
+ "type": "object"
+ },
+ "QuotaOperation": {
+ "description": "Represents information regarding a quota operation.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels describing the operation.",
+ "type": "object"
+ },
+ "consumerId": {
+ "description": "Identity of the consumer for whom this quota operation is being performed.\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.",
+ "type": "string"
+ },
+ "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": {
+ "enum": [
+ "UNSPECIFIED",
+ "NORMAL",
+ "BEST_EFFORT",
+ "CHECK_ONLY"
+ ],
+ "description": "Quota mode for this operation.",
+ "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."
+ ]
+ },
+ "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"
+ },
+ "EndReconciliationRequest": {
+ "description": "Request message for QuotaController.EndReconciliation.",
+ "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"
+ }
+ },
+ "id": "EndReconciliationRequest"
+ },
+ "ReportInfo": {
+ "properties": {
+ "operationId": {
+ "description": "The Operation.operation_id value from the request.",
+ "type": "string"
+ },
+ "quotaInfo": {
+ "description": "Quota usage info when processing the `Operation`.",
+ "$ref": "QuotaInfo"
+ }
+ },
+ "id": "ReportInfo",
+ "description": "Contains additional info about the report operation.",
+ "type": "object"
+ },
+ "ReportResponse": {
+ "description": "Response message for the Report method.",
+ "type": "object",
+ "properties": {
+ "reportInfos": {
+ "description": "Quota usage for each quota release `Operation` request.\n\nFully or partially failed quota release request may or may not be present\nin `report_quota_info`. For example, a failed quota release request will\nhave the current quota usage info when precise quota library returns the\ninfo. A deadline exceeded quota request will not have quota usage info.\n\nIf there is no quota release request, report_quota_info will be empty.\n",
+ "type": "array",
+ "items": {
+ "$ref": "ReportInfo"
+ }
+ },
+ "serviceConfigId": {
+ "description": "The actual config id used to process the request.",
+ "type": "string"
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "ReportError"
+ }
+ }
+ },
+ "id": "ReportResponse"
+ },
+ "Operation": {
+ "properties": {
+ "startTime": {
+ "description": "Required. Start time of the operation.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "importance": {
+ "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."
+ ],
+ "enum": [
+ "LOW",
+ "HIGH",
+ "DEBUG"
+ ]
+ },
+ "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": {
+ "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",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "resources": {
+ "description": "The resources that are involved in the operation.",
+ "type": "array",
+ "items": {
+ "$ref": "ResourceInfo"
+ }
+ },
+ "logEntries": {
+ "description": "Represents information to be logged.",
+ "type": "array",
+ "items": {
+ "$ref": "LogEntry"
+ }
+ },
+ "userLabels": {
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricValueSet"
+ }
+ },
+ "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.",
+ "type": "string"
+ },
+ "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"
+ },
+ "CheckResponse": {
+ "description": "Response message for the Check method.",
+ "type": "object",
+ "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"
+ },
+ "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"
+ },
+ "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"
+ }
+ },
+ "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": {
+ "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",
+ "items": {
+ "$ref": "AuthorizationInfo"
+ }
+ },
+ "request": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "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."
+ },
+ "authenticationInfo": {
+ "$ref": "AuthenticationInfo",
+ "description": "Authentication information."
+ },
+ "status": {
+ "$ref": "Status",
+ "description": "The status of the overall operation."
+ },
+ "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": {
+ "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"
+ }
+ },
+ "id": "AuditLog"
+ },
+ "LogEntry": {
+ "description": "An individual log entry.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "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\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`.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "timestamp": {
+ "description": "The time the event described by the log entry occurred. If\nomitted, defaults to operation start time.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "LogEntry"
+ },
+ "MetricValue": {
+ "description": "Represents a single metric value.",
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "description": "The start of the time period over which this metric value's measurement\napplies. The time period has different semantics for different metric\ntypes (cumulative, delta, and gauge). See the metric definition\ndocumentation in the service configuration for details.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "moneyValue": {
+ "description": "A money value.",
+ "$ref": "Money"
+ },
+ "stringValue": {
+ "description": "A text string value.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding relationship.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "doubleValue": {
+ "description": "A double precision floating point value.",
+ "format": "double",
+ "type": "number"
+ },
+ "int64Value": {
+ "description": "A signed 64-bit integer value.",
+ "format": "int64",
+ "type": "string"
+ },
+ "distributionValue": {
+ "$ref": "Distribution",
+ "description": "A distribution value."
+ },
+ "boolValue": {
+ "description": "A boolean value.",
+ "type": "boolean"
+ },
+ "endTime": {
+ "description": "The end of the time period over which this metric value's measurement\napplies.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "MetricValue"
+ },
+ "EndReconciliationResponse": {
+ "description": "Response message for QuotaController.EndReconciliation.",
+ "type": "object",
+ "properties": {
+ "operationId": {
+ "description": "The same operation_id value used in the EndReconciliationRequest. Used for\nlogging and diagnostics purposes.",
+ "type": "string"
+ },
+ "reconciliationErrors": {
+ "description": "Indicates the decision of the reconciliation end.",
+ "type": "array",
+ "items": {
+ "$ref": "QuotaError"
+ }
+ },
+ "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",
+ "items": {
+ "$ref": "MetricValueSet"
+ }
+ }
+ },
+ "id": "EndReconciliationResponse"
+ },
+ "Money": {
+ "properties": {
+ "currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "type": "string"
+ },
+ "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"
+ },
+ "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",
+ "description": "Represents an amount of money with its currency type.",
+ "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"
},
+ "protocol": "rest",
"canonicalName": "Service Control",
"auth": {
"oauth2": {
@@ -1145,279 +1419,5 @@
"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": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "parameters": {
- "serviceName": {
- "location": "path",
- "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"
- }
- },
- "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"
- },
- "response": {
- "$ref": "ReleaseQuotaResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST"
- },
- "endReconciliation": {
- "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.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "flatPath": "v1/services/{serviceName}:endReconciliation",
- "path": "v1/services/{serviceName}:endReconciliation",
- "id": "servicecontrol.services.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)."
- },
- "report": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "flatPath": "v1/services/{serviceName}:report",
- "path": "v1/services/{serviceName}:report",
- "id": "servicecontrol.services.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"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST"
- },
- "allocateQuota": {
- "parameters": {
- "serviceName": {
- "location": "path",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "flatPath": "v1/services/{serviceName}:allocateQuota",
- "id": "servicecontrol.services.allocateQuota",
- "path": "v1/services/{serviceName}: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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "AllocateQuotaResponse"
- }
- },
- "startReconciliation": {
- "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}:startReconciliation",
- "path": "v1/services/{serviceName}:startReconciliation",
- "id": "servicecontrol.services.startReconciliation",
- "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).",
- "request": {
- "$ref": "StartReconciliationRequest"
- },
- "response": {
- "$ref": "StartReconciliationResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST"
- },
- "check": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "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",
- "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"
- ],
- "httpMethod": "POST"
- }
- }
- }
- },
- "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": {
- "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"
- },
- "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": {
- "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://servicecontrol.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Google Service Control provides control plane functionality to managed services, such as logging, monitoring, and status checks.",
- "servicePath": "",
- "basePath": "",
- "revision": "20171211",
- "id": "servicecontrol:v1",
- "documentationLink": "https://cloud.google.com/service-control/"
+ "batchPath": "batch"
}
diff --git a/servicemanagement/v1/servicemanagement-api.json b/servicemanagement/v1/servicemanagement-api.json
index 97c41ac..c62141c 100644
--- a/servicemanagement/v1/servicemanagement-api.json
+++ b/servicemanagement/v1/servicemanagement-api.json
@@ -1,51 +1,2984 @@
{
+ "resources": {
+ "services": {
+ "methods": {
+ "create": {
+ "request": {
+ "$ref": "ManagedService"
+ },
+ "description": "Creates a new managed service.\nPlease note one producer project can own no more than 20 services.\n\nOperation\u003cresponse: ManagedService\u003e",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/services",
+ "id": "servicemanagement.services.create",
+ "path": "v1/services"
+ },
+ "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": {
+ "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}",
+ "path": "v1/services/{serviceName}",
+ "id": "servicemanagement.services.get",
+ "description": "Gets a managed service. Authentication is required unless the service is\npublic."
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^services/[^/]+$",
+ "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}: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."
+ },
+ "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."
+ },
+ "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",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/services/{serviceName}",
+ "path": "v1/services/{serviceName}",
+ "id": "servicemanagement.services.delete"
+ },
+ "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",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "Name of the service to enable. Specifying an unknown service name will\ncause the request to fail.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ },
+ "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": "^services/[^/]+$",
+ "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/service.management"
+ ],
+ "flatPath": "v1/services/{servicesId}:setIamPolicy",
+ "id": "servicemanagement.services.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy"
+ },
+ "disable": {
+ "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": "Name of the service to disable. Specifying an unknown service name\nwill cause the request to fail.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:disable",
+ "path": "v1/services/{serviceName}:disable",
+ "id": "servicemanagement.services.disable",
+ "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",
+ "request": {
+ "$ref": "DisableServiceRequest"
+ }
+ },
+ "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",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v1/services/{servicesId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "servicemanagement.services.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"
+ }
+ },
+ "undelete": {
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "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"
+ },
+ "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",
+ "parameters": {
+ "consumerId": {
+ "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",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Token identifying which result to start with; returned by a previous list\ncall.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "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",
+ "path": "v1/services",
+ "id": "servicemanagement.services.list"
+ }
+ },
+ "resources": {
+ "configs": {
+ "methods": {
+ "create": {
+ "path": "v1/services/{serviceName}/configs",
+ "id": "servicemanagement.services.configs.create",
+ "request": {
+ "$ref": "Service"
+ },
+ "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.",
+ "response": {
+ "$ref": "Service"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "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}/configs"
+ },
+ "submit": {
+ "request": {
+ "$ref": "SubmitConfigSourceRequest"
+ },
+ "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",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "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}/configs:submit",
+ "path": "v1/services/{serviceName}/configs:submit",
+ "id": "servicemanagement.services.configs.submit"
+ },
+ "list": {
+ "path": "v1/services/{serviceName}/configs",
+ "id": "servicemanagement.services.configs.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",
+ "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": {
+ "description": "The max number of items to include in the response list.",
+ "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/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "flatPath": "v1/services/{serviceName}/configs"
+ },
+ "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": {
+ "location": "path",
+ "description": "The id of the service configuration resource.",
+ "required": true,
+ "type": "string"
+ },
+ "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}/configs/{configId}",
+ "path": "v1/services/{serviceName}/configs/{configId}",
+ "id": "servicemanagement.services.configs.get",
+ "description": "Gets a service configuration (version) for a managed service."
+ }
+ }
+ },
+ "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": {
+ "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": "^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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "servicemanagement.services.consumers.setIamPolicy"
+ },
+ "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",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "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/[^/]+/consumers/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "servicemanagement.services.consumers.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"
+ }
+ }
+ }
+ },
+ "rollouts": {
+ "methods": {
+ "list": {
+ "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",
+ "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"
+ },
+ "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"
+ }
+ },
+ "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}/rollouts"
+ },
+ "get": {
+ "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": {
+ "description": "The id of the rollout resource.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}/rollouts/{rolloutId}",
+ "path": "v1/services/{serviceName}/rollouts/{rolloutId}",
+ "id": "servicemanagement.services.rollouts.get",
+ "description": "Gets a service configuration rollout."
+ },
+ "create": {
+ "path": "v1/services/{serviceName}/rollouts",
+ "id": "servicemanagement.services.rollouts.create",
+ "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",
+ "request": {
+ "$ref": "Rollout"
+ },
+ "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}/rollouts"
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "list": {
+ "id": "servicemanagement.operations.list",
+ "path": "v1/operations",
+ "description": "Lists service operations that match the specified filter in the request.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [],
+ "parameters": {
+ "name": {
+ "location": "query",
+ "description": "Not used.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "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": {
+ "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",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/operations"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "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",
+ "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": {
+ "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"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://servicemanagement.googleapis.com/",
"kind": "discovery#restDescription",
"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.",
"servicePath": "",
"basePath": "",
+ "id": "servicemanagement:v1",
"revision": "20171208",
"documentationLink": "https://cloud.google.com/service-management/",
- "id": "servicemanagement:v1",
"discoveryVersion": "v1",
"schemas": {
- "CustomError": {
+ "LabelDescriptor": {
+ "description": "A description of a label.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "description": {
+ "description": "A human-readable description for the label.",
+ "type": "string"
+ }
+ },
+ "id": "LabelDescriptor"
+ },
+ "Diagnostic": {
+ "properties": {
+ "kind": {
+ "enum": [
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "The kind of diagnostic information provided.",
+ "type": "string",
+ "enumDescriptions": [
+ "Warnings and errors",
+ "Only errors"
+ ]
+ },
+ "message": {
+ "description": "Message describing the error or warning.",
+ "type": "string"
+ },
+ "location": {
+ "description": "File name and line number of the error or warning.",
+ "type": "string"
+ }
+ },
+ "id": "Diagnostic",
+ "description": "Represents a diagnostic message (error or warning)",
+ "type": "object"
+ },
+ "EnableServiceRequest": {
+ "properties": {
+ "consumerId": {
+ "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",
+ "description": "Request message for EnableService method.",
+ "type": "object"
+ },
+ "Type": {
+ "description": "A protocol buffer message type.",
+ "type": "object",
+ "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"
+ },
+ "GenerateConfigReportResponse": {
+ "properties": {
+ "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",
+ "items": {
+ "$ref": "ChangeReport"
+ }
+ },
+ "id": {
+ "description": "ID of the service configuration this report belongs to.",
+ "type": "string"
+ },
+ "diagnostics": {
+ "description": "Errors / Linter warnings associated with the service definition this\nreport\nbelongs to.",
+ "type": "array",
+ "items": {
+ "$ref": "Diagnostic"
+ }
+ }
+ },
+ "id": "GenerateConfigReportResponse",
+ "description": "Response message for GenerateConfigReport method.",
+ "type": "object"
+ },
+ "ListServiceConfigsResponse": {
+ "properties": {
+ "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.",
+ "type": "object"
+ },
+ "Experimental": {
+ "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
+ "type": "object",
+ "properties": {
+ "authorization": {
+ "description": "Authorization configuration.",
+ "$ref": "AuthorizationConfig"
+ }
+ },
+ "id": "Experimental"
+ },
+ "Backend": {
+ "description": "`Backend` defines the backend configuration for a service.",
"type": "object",
"properties": {
"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.",
+ "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.",
"type": "array",
"items": {
- "$ref": "CustomErrorRule"
+ "$ref": "BackendRule"
+ }
+ }
+ },
+ "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",
+ "items": {
+ "$ref": "AuditLogConfig"
}
},
- "types": {
- "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
+ "exemptedMembers": {
"type": "array",
"items": {
"type": "string"
}
}
},
+ "id": "AuditConfig"
+ },
+ "SubmitConfigSourceRequest": {
+ "description": "Request message for SubmitConfigSource method.",
+ "type": "object",
+ "properties": {
+ "validateOnly": {
+ "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"
+ },
+ "configSource": {
+ "$ref": "ConfigSource",
+ "description": "The source configuration for the service."
+ }
+ },
+ "id": "SubmitConfigSourceRequest"
+ },
+ "DocumentationRule": {
+ "properties": {
+ "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",
+ "description": "A documentation rule provides information about individual API elements.",
+ "type": "object"
+ },
+ "AuthorizationConfig": {
+ "properties": {
+ "provider": {
+ "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
+ "type": "string"
+ }
+ },
+ "id": "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"
+ },
+ "ContextRule": {
+ "description": "A context rule provides information about the context for an individual API\nelement.",
+ "type": "object",
+ "properties": {
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "provided": {
+ "description": "A list of full type names of provided contexts.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "requested": {
+ "description": "A list of full type names of requested contexts.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ContextRule"
+ },
+ "SourceContext": {
+ "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",
+ "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
+ "type": "object"
+ },
+ "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": {
+ "metricKind": {
+ "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",
+ "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."
+ ]
+ },
+ "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.\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"
+ },
+ "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",
+ "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\nURL-encoded. All user-defined custom metric types have the DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchical\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \"appengine.googleapis.com/http/server/response_latencies\"",
+ "type": "string"
+ },
+ "valueType": {
+ "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`.",
+ "The value is a signed 64-bit integer.",
+ "The value is a double precision floating point number.",
+ "The value is a text string.\nThis 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.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
+ "type": "string"
+ }
+ },
+ "id": "MetricDescriptor"
+ },
+ "Billing": {
+ "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"
+ }
+ }
+ },
+ "id": "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"
+ },
+ "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"
+ },
+ "ListServicesResponse": {
+ "properties": {
+ "services": {
+ "description": "The returned services will only have the name field set.",
+ "type": "array",
+ "items": {
+ "$ref": "ManagedService"
+ }
+ },
+ "nextPageToken": {
+ "description": "Token that can be passed to `ListServices` to resume a paginated query.",
+ "type": "string"
+ }
+ },
+ "id": "ListServicesResponse",
+ "description": "Response message for `ListServices` method.",
+ "type": "object"
+ },
+ "Endpoint": {
+ "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",
+ "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"
+ },
+ "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",
+ "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"
+ }
+ },
+ "id": "OAuthRequirements"
+ },
+ "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"
+ },
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
+ },
+ "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",
+ "items": {
+ "$ref": "UsageRule"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "id": "Usage"
+ },
+ "Context": {
+ "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",
+ "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"
+ },
+ "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": "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).",
+ "type": "string"
+ },
+ "fileType": {
+ "enum": [
+ "FILE_TYPE_UNSPECIFIED",
+ "SERVICE_CONFIG_YAML",
+ "OPEN_API_JSON",
+ "OPEN_API_YAML",
+ "FILE_DESCRIPTOR_SET_PROTO",
+ "PROTO_FILE"
+ ],
+ "description": "The type of configuration file this represents.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown file type.",
+ "YAML-specification of service.",
+ "OpenAPI specification, serialized in JSON.",
+ "OpenAPI specification, serialized in YAML.",
+ "FileDescriptorSet, generated by protoc.\n\nTo generate, use protoc with imports and source info included.\nFor an example test.proto file, the following command would put the value\nin a new file named out.pb.\n\n$protoc --include_imports --include_source_info test.proto -o out.pb",
+ "Uncompiled Proto file. Used for storage and display purposes only,\ncurrently server-side compilation is not supported. Should match the\ninputs to 'protoc' command used to generated FILE_DESCRIPTOR_SET_PROTO. A\nfile of this type can only be included if at least one file of type\nFILE_DESCRIPTOR_SET_PROTO is included."
+ ]
+ },
+ "fileContents": {
+ "description": "The bytes that constitute the file.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "ConfigFile"
+ },
+ "CustomErrorRule": {
+ "description": "A custom error rule.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "MonitoredResourceDescriptor"
+ },
+ "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": {
+ "properties": {
+ "useDirectDownload": {
+ "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
+ "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"
+ },
+ "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"
+ }
+ },
+ "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.",
+ "type": "object"
+ },
+ "ChangeReport": {
+ "properties": {
+ "configChanges": {
+ "description": "List of changes between two service configurations.\nThe changes will be alphabetically sorted based on the identifier\nof each change.\nA ConfigChange identifier is a dot separated path to the configuration.\nExample: visibility.rules[selector='LibraryService.CreateBook'].restriction",
+ "type": "array",
+ "items": {
+ "$ref": "ConfigChange"
+ }
+ }
+ },
+ "id": "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.",
+ "type": "object"
+ },
+ "DisableServiceRequest": {
+ "description": "Request message for DisableService method.",
+ "type": "object",
+ "properties": {
+ "consumerId": {
+ "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": {
+ "description": "Response message for SubmitConfigSource method.",
+ "type": "object",
+ "properties": {
+ "serviceConfig": {
+ "$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": {
+ "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"
+ },
+ "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": {
+ "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",
+ "description": "Configuration of a specific billing destination (Currently only support\nbill against consumer project).",
+ "type": "object"
+ },
+ "Advice": {
+ "description": "Generated advice about this change, used for providing more\ninformation about how a change will affect the existing service.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "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": {
+ "properties": {
+ "serviceName": {
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements.",
+ "type": "string"
+ },
+ "producerProjectId": {
+ "description": "ID of the project that produces and owns this service.",
+ "type": "string"
+ }
+ },
+ "id": "ManagedService",
+ "description": "The full representation of a Service that is managed by\nGoogle Service Management.",
+ "type": "object"
+ },
+ "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": {
+ "allowUnregisteredCalls": {
+ "description": "True, if the method allows unregistered calls; false otherwise.",
+ "type": "boolean"
+ },
+ "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": "True, if the method should skip service control. If so, no control plane\nfeature (like quota and billing) will be enabled.\nThis flag is used by ESP to allow some Endpoints customers to bypass\nGoogle internal checks.",
+ "type": "boolean"
+ }
+ },
+ "id": "UsageRule"
+ },
+ "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 }",
+ "type": "object",
+ "properties": {
+ "percentages": {
+ "additionalProperties": {
+ "format": "double",
+ "type": "number"
+ },
+ "description": "Maps service configuration IDs to their corresponding traffic percentage.\nKey is the service configuration ID, Value is the traffic percentage\nwhich must be greater than 0.0 and the sum must equal to 100.0.",
+ "type": "object"
+ }
+ },
+ "id": "TrafficPercentStrategy"
+ },
+ "AuthRequirement": {
+ "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",
+ "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"
+ },
+ "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": {
+ "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"
+ }
+ },
+ "summary": {
+ "description": "A short summary of what the service does. Can only be provided by\nplain text.",
+ "type": "string"
+ }
+ },
+ "id": "Documentation"
+ },
+ "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"
+ },
+ "ConfigSource": {
+ "properties": {
+ "files": {
+ "description": "Set of source configuration files that are used to generate a service\nconfiguration (`google.api.Service`).",
+ "type": "array",
+ "items": {
+ "$ref": "ConfigFile"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "ConfigSource",
+ "description": "Represents a source file which is used to generate the service configuration\ndefined by `google.api.Service`.",
+ "type": "object"
+ },
+ "BackendRule": {
+ "description": "A backend rule provides configuration for an individual API element.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "minDeadline": {
+ "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "BackendRule"
+ },
+ "AuthenticationRule": {
+ "properties": {
+ "oauth": {
+ "description": "The requirements for OAuth credentials.",
+ "$ref": "OAuthRequirements"
+ },
+ "customAuth": {
+ "description": "Configuration for custom authentication.",
+ "$ref": "CustomAuthRequirements"
+ },
+ "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",
+ "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"
+ },
+ "UndeleteServiceResponse": {
+ "description": "Response message for UndeleteService method.",
+ "type": "object",
+ "properties": {
+ "service": {
+ "description": "Revived service resource.",
+ "$ref": "ManagedService"
+ }
+ },
+ "id": "UndeleteServiceResponse"
+ },
+ "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"
+ },
+ "Api": {
+ "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"
+ },
+ "sourceContext": {
+ "description": "Source context for the protocol buffer service represented by this\nmessage.",
+ "$ref": "SourceContext"
+ },
+ "syntax": {
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of the service.",
+ "type": "string"
+ },
+ "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",
+ "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"
+ },
+ "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"
+ },
+ "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"
+ }
+ }
+ },
+ "id": "Authentication"
+ },
+ "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."
+ },
+ "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"
+ },
+ "Page": {
+ "properties": {
+ "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"
+ },
+ "subpages": {
+ "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ }
+ },
+ "id": "Page",
+ "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
+ "type": "object"
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ },
+ "EnumValue": {
+ "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",
+ "description": "Enum value definition.",
+ "type": "object"
+ },
+ "Service": {
+ "properties": {
+ "visibility": {
+ "description": "API visibility configuration.",
+ "$ref": "Visibility"
+ },
+ "quota": {
+ "description": "Quota configuration.",
+ "$ref": "Quota"
+ },
+ "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": {
+ "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."
+ },
+ "systemParameters": {
+ "description": "System parameter configuration.",
+ "$ref": "SystemParameters"
+ },
+ "backend": {
+ "$ref": "Backend",
+ "description": "API backend 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": {
+ "description": "Context configuration.",
+ "$ref": "Context"
+ },
+ "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": {
+ "$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": {
+ "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"
+ }
+ }
+ },
+ "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",
+ "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"
+ },
+ "OperationMetadata": {
+ "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",
+ "description": "The metadata associated with a long running operation resource.",
+ "type": "object"
+ },
+ "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": {
+ "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",
+ "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
+ "type": "object"
+ },
+ "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": {
+ "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": {
+ "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"
+ },
+ "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."
+ }
+ },
+ "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": {
+ "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",
+ "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
+ "type": "object"
+ },
+ "Visibility": {
+ "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.",
+ "type": "object"
+ },
+ "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"
+ },
+ "ConfigChange": {
+ "properties": {
+ "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": {
+ "description": "Value of the changed object in the new Service configuration,\nin JSON format. This field will not be populated if ChangeType == REMOVED.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "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.",
+ "type": "object"
+ },
+ "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"
+ },
+ "Rollout": {
+ "properties": {
+ "trafficPercentStrategy": {
+ "description": "Google Service Control selects service configurations based on\ntraffic percentage.",
+ "$ref": "TrafficPercentStrategy"
+ },
+ "createdBy": {
+ "description": "The user who created the Rollout. Readonly.",
+ "type": "string"
+ },
+ "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": {
+ "description": "Creation time of the rollout. Readonly.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "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"
+ },
+ "GenerateConfigReportRequest": {
+ "description": "Request message for GenerateConfigReport method.",
+ "type": "object",
+ "properties": {
+ "oldConfig": {
+ "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",
+ "type": "object"
+ },
+ "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"
+ }
+ },
+ "id": "GenerateConfigReportRequest"
+ },
+ "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": {
+ "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",
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object"
+ },
+ "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"
+ },
+ "Step": {
+ "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.",
+ "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": {
+ "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": {
+ "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",
+ "type": "object"
+ },
+ "QuotaLimit": {
+ "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": {
+ "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"
+ }
+ },
+ "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`.",
+ "type": "object"
+ },
+ "Method": {
+ "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": {
+ "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"
+ }
+ },
+ "id": "Method",
+ "description": "Method represents a method of an API interface.",
+ "type": "object"
+ },
+ "ListServiceRolloutsResponse": {
+ "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",
+ "description": "Response message for ListServiceRollouts method.",
+ "type": "object"
+ },
+ "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"
+ },
+ "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": {
+ "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"
+ },
+ "FlowOperationMetadata": {
+ "properties": {
+ "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"
+ ]
+ },
+ "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"
+ },
+ "resourceNames": {
+ "description": "The full name of the resources that this flow is directly associated with.",
+ "type": "array",
+ "items": {
+ "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"
+ }
+ },
+ "id": "FlowOperationMetadata",
+ "description": "The metadata associated with a long running operation resource.",
+ "type": "object"
+ },
+ "CustomError": {
+ "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"
+ "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"
},
"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"
- },
- "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."
+ }
}
},
- "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"
+ "id": "Http"
},
"SourceInfo": {
"description": "Source information used to create a Service Config",
@@ -66,43 +2999,39 @@
"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"
+ "id": "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"
},
"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": {
+ "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": {
- "type": "string",
- "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive."
- },
- "urlQueryParameter": {
- "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
+ "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
"type": "string"
}
},
- "id": "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"
},
"Field": {
+ "description": "A single field of a message type.",
"type": "object",
"properties": {
- "number": {
- "description": "The field number.",
- "format": "int32",
- "type": "integer"
- },
"jsonName": {
"description": "The field JSON name.",
"type": "string"
@@ -166,7 +3095,6 @@
"type": "integer"
},
"cardinality": {
- "type": "string",
"enumDescriptions": [
"For fields with unknown cardinality.",
"For optional fields.",
@@ -179,7 +3107,8 @@
"CARDINALITY_REQUIRED",
"CARDINALITY_REPEATED"
],
- "description": "The field cardinality."
+ "description": "The field cardinality.",
+ "type": "string"
},
"packed": {
"description": "Whether to use alternative packed wire representation.",
@@ -196,14 +3125,16 @@
"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."
+ "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.",
@@ -220,11 +3151,11 @@
}
}
},
- "id": "Monitoring"
+ "id": "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"
},
"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).",
@@ -234,12 +3165,28 @@
}
}
},
- "id": "TestIamPermissionsRequest"
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object"
},
"Enum": {
- "description": "Enum type definition.",
- "type": "object",
"properties": {
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "The source context."
+ },
+ "syntax": {
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax.",
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ]
+ },
"name": {
"description": "Enum type name.",
"type": "string"
@@ -257,2115 +3204,25 @@
"items": {
"$ref": "Option"
}
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- },
- "syntax": {
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string"
}
},
- "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"
- },
- "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"
- },
- "Diagnostic": {
- "description": "Represents a diagnostic message (error or warning)",
- "type": "object",
- "properties": {
- "kind": {
- "enum": [
- "WARNING",
- "ERROR"
- ],
- "description": "The kind of diagnostic information provided.",
- "type": "string",
- "enumDescriptions": [
- "Warnings and errors",
- "Only errors"
- ]
- },
- "message": {
- "description": "Message describing the error or warning.",
- "type": "string"
- },
- "location": {
- "description": "File name and line number of the error or warning.",
- "type": "string"
- }
- },
- "id": "Diagnostic"
- },
- "EnableServiceRequest": {
- "description": "Request message for EnableService method.",
- "type": "object",
- "properties": {
- "consumerId": {
- "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": {
- "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"
- }
- },
- "syntax": {
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string"
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- }
- },
- "id": "Type",
- "description": "A protocol buffer message type.",
- "type": "object"
- },
- "GenerateConfigReportResponse": {
- "description": "Response message for GenerateConfigReport method.",
- "type": "object",
- "properties": {
- "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"
- },
- "changeReports": {
- "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations.",
- "type": "array",
- "items": {
- "$ref": "ChangeReport"
- }
- },
- "id": {
- "description": "ID of the service configuration this report belongs to.",
- "type": "string"
- }
- },
- "id": "GenerateConfigReportResponse"
- },
- "ListServiceConfigsResponse": {
- "type": "object",
- "properties": {
- "serviceConfigs": {
- "type": "array",
- "items": {
- "$ref": "Service"
- },
- "description": "The list of service configuration resources."
- },
- "nextPageToken": {
- "description": "The token of the next page of results.",
- "type": "string"
- }
- },
- "id": "ListServiceConfigsResponse",
- "description": "Response message for ListServiceConfigs method."
- },
- "Experimental": {
- "type": "object",
- "properties": {
- "authorization": {
- "$ref": "AuthorizationConfig",
- "description": "Authorization configuration."
- }
- },
- "id": "Experimental",
- "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users."
- },
- "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.",
- "type": "array",
- "items": {
- "$ref": "BackendRule"
- }
- }
- },
- "id": "Backend"
- },
- "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"
- }
- },
- "exemptedMembers": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "SubmitConfigSourceRequest": {
- "properties": {
- "validateOnly": {
- "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"
- },
- "configSource": {
- "$ref": "ConfigSource",
- "description": "The source configuration for the service."
- }
- },
- "id": "SubmitConfigSourceRequest",
- "description": "Request message for SubmitConfigSource method.",
- "type": "object"
- },
- "DocumentationRule": {
- "id": "DocumentationRule",
- "description": "A documentation rule provides information about individual API elements.",
- "type": "object",
- "properties": {
- "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"
- },
- "description": {
- "description": "Description of the selected API(s).",
- "type": "string"
- }
- }
- },
- "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",
- "properties": {
- "provider": {
- "type": "string",
- "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com."
- }
- },
- "id": "AuthorizationConfig"
- },
- "ContextRule": {
- "description": "A context rule provides information about the context for an individual API\nelement.",
- "type": "object",
- "properties": {
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "provided": {
- "description": "A list of full type names of provided contexts.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "requested": {
- "description": "A list of full type names of requested contexts.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ContextRule"
- },
- "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": {
- "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"
- }
- }
- },
- "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": {
- "type": {
- "description": "The metric type, including its DNS name prefix. The type is not\nURL-encoded. All user-defined custom metric types have the DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchical\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \"appengine.googleapis.com/http/server/response_latencies\"",
- "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`.",
- "The value is a signed 64-bit integer.",
- "The value is a double precision floating point number.",
- "The value is a text string.\nThis 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": "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",
- "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"
- ]
- },
- "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": {
- "type": "string",
- "description": "A detailed description of the metric, which can be used in documentation."
- },
- "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",
- "items": {
- "$ref": "LabelDescriptor"
- }
- },
- "name": {
- "description": "The resource name of the metric descriptor.",
- "type": "string"
- }
- },
- "id": "MetricDescriptor"
- },
- "Billing": {
- "id": "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": {
- "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"
- }
- }
- }
- },
- "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\"",
- "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"
- }
- }
- },
- "ListServicesResponse": {
- "id": "ListServicesResponse",
- "description": "Response message for `ListServices` method.",
- "type": "object",
- "properties": {
- "services": {
- "description": "The returned services will only have the name field set.",
- "type": "array",
- "items": {
- "$ref": "ManagedService"
- }
- },
- "nextPageToken": {
- "description": "Token that can be passed to `ListServices` to resume a paginated query.",
- "type": "string"
- }
- }
- },
- "Endpoint": {
- "properties": {
- "name": {
- "type": "string",
- "description": "The canonical name of this endpoint."
- },
- "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"
- }
- },
- "features": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The list of features enabled on this endpoint."
- },
- "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",
- "type": "object"
- },
- "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",
- "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"
- }
- },
- "id": "OAuthRequirements"
- },
- "Usage": {
- "id": "Usage",
- "description": "Configuration controlling usage of a service.",
- "type": "object",
- "properties": {
- "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"
- }
- },
- "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": {
- "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"
- }
- }
- },
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
- },
- "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"
- },
- "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": {
- "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": {
- "type": "string",
- "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details."
- },
- "displayName": {
- "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
- "type": "string"
- },
- "labels": {
- "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."
- }
- },
- "id": "LogDescriptor"
- },
- "ConfigFile": {
- "properties": {
- "filePath": {
- "description": "The file name of the configuration file (full or relative path).",
- "type": "string"
- },
- "fileType": {
- "description": "The type of configuration file this represents.",
- "type": "string",
- "enumDescriptions": [
- "Unknown file type.",
- "YAML-specification of service.",
- "OpenAPI specification, serialized in JSON.",
- "OpenAPI specification, serialized in YAML.",
- "FileDescriptorSet, generated by protoc.\n\nTo generate, use protoc with imports and source info included.\nFor an example test.proto file, the following command would put the value\nin a new file named out.pb.\n\n$protoc --include_imports --include_source_info test.proto -o out.pb",
- "Uncompiled Proto file. Used for storage and display purposes only,\ncurrently server-side compilation is not supported. Should match the\ninputs to 'protoc' command used to generated FILE_DESCRIPTOR_SET_PROTO. A\nfile of this type can only be included if at least one file of type\nFILE_DESCRIPTOR_SET_PROTO is included."
- ],
- "enum": [
- "FILE_TYPE_UNSPECIFIED",
- "SERVICE_CONFIG_YAML",
- "OPEN_API_JSON",
- "OPEN_API_YAML",
- "FILE_DESCRIPTOR_SET_PROTO",
- "PROTO_FILE"
- ]
- },
- "fileContents": {
- "description": "The bytes that constitute the file.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "ConfigFile",
- "description": "Generic specification of a source configuration file",
- "type": "object"
- },
- "CustomErrorRule": {
- "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",
- "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": {
- "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"
- }
- }
- },
- "id": "MonitoredResourceDescriptor"
- },
- "MediaDownload": {
- "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.",
- "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"
- }
- }
- },
- "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"
- },
- "ChangeReport": {
- "type": "object",
- "properties": {
- "configChanges": {
- "description": "List of changes between two service configurations.\nThe changes will be alphabetically sorted based on the identifier\nof each change.\nA ConfigChange identifier is a dot separated path to the configuration.\nExample: visibility.rules[selector='LibraryService.CreateBook'].restriction",
- "type": "array",
- "items": {
- "$ref": "ConfigChange"
- }
- }
- },
- "id": "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."
- },
- "DisableServiceRequest": {
- "description": "Request message for DisableService method.",
- "type": "object",
- "properties": {
- "consumerId": {
- "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": {
- "description": "Response message for SubmitConfigSource method.",
- "type": "object",
- "properties": {
- "serviceConfig": {
- "description": "The generated service configuration.",
- "$ref": "Service"
- }
- },
- "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": {
- "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"
- },
- "mimeTypes": {
- "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "maxSize": {
- "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
- "format": "int64",
- "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.",
- "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"
- },
- "Advice": {
- "description": "Generated advice about this change, used for providing more\ninformation about how a change will affect the existing service.",
- "type": "object",
- "properties": {
- "description": {
- "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": {
- "serviceName": {
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements.",
- "type": "string"
- },
- "producerProjectId": {
- "description": "ID of the project that produces and owns this service.",
- "type": "string"
- }
- },
- "id": "ManagedService"
- },
- "UsageRule": {
- "type": "object",
- "properties": {
- "allowUnregisteredCalls": {
- "description": "True, if the method allows unregistered calls; false otherwise.",
- "type": "boolean"
- },
- "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": "True, if the method should skip service control. If so, no control plane\nfeature (like quota and billing) will be enabled.\nThis flag is used by ESP to allow some Endpoints customers to bypass\nGoogle internal checks.",
- "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"
- },
- "AuthRequirement": {
- "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",
- "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": {
- "id": "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 }",
- "type": "object",
- "properties": {
- "percentages": {
- "additionalProperties": {
- "format": "double",
- "type": "number"
- },
- "description": "Maps service configuration IDs to their corresponding traffic percentage.\nKey is the service configuration ID, Value is the traffic percentage\nwhich must be greater than 0.0 and the sum must equal to 100.0.",
- "type": "object"
- }
- }
- },
- "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": {
- "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"
- }
- },
- "summary": {
- "description": "A short summary of what the service does. Can only be provided by\nplain text.",
- "type": "string"
- }
- }
- },
- "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": {
- "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"
- ]
- }
- },
- "id": "AuditLogConfig"
- },
- "ConfigSource": {
- "properties": {
- "files": {
- "type": "array",
- "items": {
- "$ref": "ConfigFile"
- },
- "description": "Set of source configuration files that are used to generate a service\nconfiguration (`google.api.Service`)."
- },
- "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"
- }
- },
- "id": "ConfigSource",
- "description": "Represents a source file which is used to generate the service configuration\ndefined by `google.api.Service`.",
- "type": "object"
- },
- "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": {
- "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": {
- "$ref": "OAuthRequirements",
- "description": "The requirements for OAuth credentials."
- },
- "customAuth": {
- "description": "Configuration for custom authentication.",
- "$ref": "CustomAuthRequirements"
- },
- "requirements": {
- "description": "Requirements for additional authentication providers.",
- "type": "array",
- "items": {
- "$ref": "AuthRequirement"
- }
- }
- },
- "id": "AuthenticationRule"
- },
- "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"
- },
- "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"
- },
- "UndeleteServiceResponse": {
- "properties": {
- "service": {
- "$ref": "ManagedService",
- "description": "Revived service resource."
- }
- },
- "id": "UndeleteServiceResponse",
- "description": "Response message for UndeleteService method.",
- "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": {
- "options": {
- "type": "array",
- "items": {
- "$ref": "Option"
- },
- "description": "Any metadata attached to the interface."
- },
- "methods": {
- "description": "The methods of this interface, in unspecified order.",
- "type": "array",
- "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"
- },
- "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"
- },
- "MetricRule": {
- "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",
- "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."
- },
- "Authentication": {
- "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"
- }
- }
- },
- "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"
- },
- "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"
- },
- "Page": {
- "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
- "type": "object",
- "properties": {
- "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": {
- "type": "string",
- "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file."
- },
- "subpages": {
- "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
- "type": "array",
- "items": {
- "$ref": "Page"
- }
- }
- },
- "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": {
- "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"
- },
- "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": {
- "type": "string",
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired"
- }
- },
- "id": "Binding"
- },
- "AuthProvider": {
- "id": "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": {
- "type": "string",
- "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\"."
- },
- "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"
- }
- }
- },
- "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"
- },
- "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": {
- "customError": {
- "$ref": "CustomError",
- "description": "Custom error configuration."
- },
- "title": {
- "description": "The product title for this service.",
- "type": "string"
- },
- "endpoints": {
- "type": "array",
- "items": {
- "$ref": "Endpoint"
- },
- "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."
- },
- "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": {
- "type": "array",
- "items": {
- "$ref": "LogDescriptor"
- },
- "description": "Defines the logs used by this service."
- },
- "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."
- },
- "backend": {
- "$ref": "Backend",
- "description": "API backend configuration."
- },
- "systemParameters": {
- "description": "System parameter configuration.",
- "$ref": "SystemParameters"
- },
- "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."
- },
- "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": {
- "$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": {
- "$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": {
- "description": "Quota configuration.",
- "$ref": "Quota"
- },
- "name": {
- "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
- "type": "string"
- },
- "billing": {
- "$ref": "Billing",
- "description": "Billing configuration."
- }
- },
- "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"
- },
- "OperationMetadata": {
- "description": "The metadata associated with a long running operation resource.",
- "type": "object",
- "properties": {
- "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"
- },
- "startTime": {
- "description": "The start time of the operation.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "OperationMetadata"
- },
- "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": {
- "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": {
- "id": "VisibilityRule",
- "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
- "type": "object",
- "properties": {
- "selector": {
- "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "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"
- }
- }
- },
- "HttpRule": {
- "type": "object",
- "properties": {
- "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."
- },
- "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"
- }
- }
- },
- "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": {
- "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
- "type": "object",
- "properties": {
- "metrics": {
- "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."
- },
- "monitoredResource": {
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
- "type": "string"
- }
- },
- "id": "MonitoringDestination"
- },
- "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": {
- "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.",
- "type": "object",
- "properties": {
- "newValue": {
- "description": "Value of the changed object in the new Service configuration,\nin JSON format. This field will not be populated if ChangeType == REMOVED.",
- "type": "string"
- },
- "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": {
- "description": "Collection of advice provided for this change, useful for determining the\npossible impact of this change.",
- "type": "array",
- "items": {
- "$ref": "Advice"
- }
- }
- },
- "id": "ConfigChange"
- },
- "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"
- }
- }
- }
- },
- "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": {
- "createTime": {
- "description": "Creation time of the rollout. Readonly.",
- "format": "google-datetime",
- "type": "string"
- },
- "status": {
- "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",
- "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."
- ]
- },
- "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": {
- "description": "Google Service Control selects service configurations based on\ntraffic percentage.",
- "$ref": "TrafficPercentStrategy"
- },
- "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": {
- "$ref": "DeleteServiceStrategy",
- "description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly."
- }
- },
- "id": "Rollout"
- },
- "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"
- },
- "GenerateConfigReportRequest": {
- "description": "Request message for GenerateConfigReport method.",
- "type": "object",
- "properties": {
- "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"
- }
- },
- "oldConfig": {
- "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",
- "type": "object"
- }
- },
- "id": "GenerateConfigReportRequest"
- },
- "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"
- },
- "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",
- "properties": {},
- "id": "DeleteServiceStrategy"
- },
- "Step": {
- "description": "Represents the status of one operation step.",
- "type": "object",
- "properties": {
- "status": {
- "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"
- ],
- "description": "The status code."
- },
- "description": {
- "description": "The short description of the step.",
- "type": "string"
- }
- },
- "id": "Step"
- },
- "LoggingDestination": {
- "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",
- "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
- "type": "object"
- },
- "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": {
- "type": "array",
- "items": {
- "$ref": "LoggingDestination"
- },
- "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."
- },
- "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": {
- "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"
- },
- "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": {
- "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",
- "additionalProperties": {
- "format": "int64",
- "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": {
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax of this method.",
- "type": "string"
- }
- },
- "id": "Method"
- },
- "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"
- },
- "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"
- },
- "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": {
- "description": "The fully qualified name of the interface which is included.",
- "type": "string"
- }
- },
- "id": "Mixin"
- },
- "FlowOperationMetadata": {
- "properties": {
- "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"
- },
- "resourceNames": {
- "description": "The full name of the resources that this flow is directly associated with.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "cancelState": {
- "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."
- ],
- "enum": [
- "RUNNING",
- "UNCANCELLABLE",
- "CANCELLED"
- ]
- },
- "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": {
- "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.",
+ "id": "Enum",
+ "description": "Enum type definition.",
"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"
+ "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 Management",
"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"
},
@@ -2374,9 +3231,6 @@
},
"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"
}
}
}
@@ -2387,859 +3241,5 @@
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Google Service Management API",
- "ownerName": "Google",
- "resources": {
- "services": {
- "resources": {
- "configs": {
- "methods": {
- "create": {
- "response": {
- "$ref": "Service"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services/{serviceName}/configs",
- "path": "v1/services/{serviceName}/configs",
- "id": "servicemanagement.services.configs.create",
- "request": {
- "$ref": "Service"
- },
- "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."
- },
- "submit": {
- "flatPath": "v1/services/{serviceName}/configs:submit",
- "id": "servicemanagement.services.configs.submit",
- "path": "v1/services/{serviceName}/configs:submit",
- "request": {
- "$ref": "SubmitConfigSourceRequest"
- },
- "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",
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ]
- },
- "list": {
- "response": {
- "$ref": "ListServiceConfigsResponse"
- },
- "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"
- },
- "pageToken": {
- "location": "query",
- "description": "The token of the page to retrieve.",
- "type": "string"
- },
- "pageSize": {
- "description": "The max number of items to include in the response list.",
- "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/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "flatPath": "v1/services/{serviceName}/configs",
- "path": "v1/services/{serviceName}/configs",
- "id": "servicemanagement.services.configs.list",
- "description": "Lists the history of the service configuration for a managed service,\nfrom the newest to the oldest."
- },
- "get": {
- "path": "v1/services/{serviceName}/configs/{configId}",
- "id": "servicemanagement.services.configs.get",
- "description": "Gets a service configuration (version) for a managed service.",
- "response": {
- "$ref": "Service"
- },
- "parameterOrder": [
- "serviceName",
- "configId"
- ],
- "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"
- },
- "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"
- }
- },
- "flatPath": "v1/services/{serviceName}/configs/{configId}"
- }
- }
- },
- "consumers": {
- "methods": {
- "setIamPolicy": {
- "id": "servicemanagement.services.consumers.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": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:setIamPolicy"
- },
- "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/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "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/[^/]+/consumers/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "servicemanagement.services.consumers.testIamPermissions"
- },
- "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "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": {
- "resource": {
- "pattern": "^services/[^/]+/consumers/[^/]+$",
- "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/services/{servicesId}/consumers/{consumersId}:getIamPolicy",
- "id": "servicemanagement.services.consumers.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy"
- }
- }
- },
- "rollouts": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListServiceRolloutsResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "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"
- }
- },
- "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}/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": {
- "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",
- "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": {
- "description": "The id of the rollout resource.",
- "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"
- ]
- },
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "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"
- }
- },
- "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",
- "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"
- }
- }
- }
- },
- "methods": {
- "testIamPermissions": {
- "id": "servicemanagement.services.testIamPermissions",
- "path": "v1/{+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.",
- "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": "^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"
- },
- "getConfig": {
- "response": {
- "$ref": "Service"
- },
- "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"
- },
- "configId": {
- "location": "query",
- "description": "The id of the service configuration resource.",
- "type": "string"
- },
- "view": {
- "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ]
- }
- },
- "flatPath": "v1/services/{serviceName}/config",
- "path": "v1/services/{serviceName}/config",
- "id": "servicemanagement.services.getConfig",
- "description": "Gets a service configuration (version) for a managed service."
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "DELETE",
- "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}",
- "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"
- },
- "enable": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "serviceName": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Name of the service to enable. Specifying an unknown service name will\ncause the request to fail."
- }
- },
- "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"
- },
- "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": "^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",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
- },
- "disable": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "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",
- "path": "v1/services/{serviceName}:disable",
- "id": "servicemanagement.services.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": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "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": {
- "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": "^services/[^/]+$"
- }
- },
- "flatPath": "v1/services/{servicesId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "servicemanagement.services.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"
- }
- },
- "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",
- "response": {
- "$ref": "Operation"
- },
- "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}:undelete",
- "path": "v1/services/{serviceName}:undelete",
- "id": "servicemanagement.services.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": {
- "location": "query",
- "description": "Token identifying which result to start with; returned by a previous list\ncall.",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Requested size of the next page of data.",
- "format": "int32"
- },
- "producerProjectId": {
- "location": "query",
- "description": "Include services produced by the specified project.",
- "type": "string"
- }
- },
- "flatPath": "v1/services"
- },
- "create": {
- "request": {
- "$ref": "ManagedService"
- },
- "description": "Creates a new managed service.\nPlease note one producer project can own no more than 20 services.\n\nOperation\u003cresponse: ManagedService\u003e",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services",
- "id": "servicemanagement.services.create",
- "path": "v1/services"
- },
- "generateConfigReport": {
- "response": {
- "$ref": "GenerateConfigReportResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services:generateConfigReport",
- "path": "v1/services:generateConfigReport",
- "id": "servicemanagement.services.generateConfigReport",
- "request": {
- "$ref": "GenerateConfigReportRequest"
- },
- "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."
- },
- "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 `ServiceManager` overview for naming\nrequirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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"
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "path": "v1/operations",
- "id": "servicemanagement.operations.list",
- "description": "Lists service operations that match the specified filter in the request.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "name": {
- "type": "string",
- "location": "query",
- "description": "Not used."
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "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": {
- "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",
- "location": "query"
- }
- },
- "flatPath": "v1/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/service.management"
- ],
- "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": "servicemanagement.operations.get"
- }
- }
- }
- },
- "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": {
- "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": {
- "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": {
- "type": "string",
- "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": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- }
- },
- "version": "v1",
- "baseUrl": "https://servicemanagement.googleapis.com/"
+ "ownerName": "Google"
}
diff --git a/serviceuser/v1/serviceuser-api.json b/serviceuser/v1/serviceuser-api.json
index 1ed9151..b32899f 100644
--- a/serviceuser/v1/serviceuser-api.json
+++ b/serviceuser/v1/serviceuser-api.json
@@ -1,4 +1,234 @@
{
+ "resources": {
+ "projects": {
+ "resources": {
+ "services": {
+ "methods": {
+ "disable": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/projects/{projectsId}/services/{servicesId}:disable",
+ "path": "v1/{+name}:disable",
+ "id": "serviceuser.projects.services.disable",
+ "request": {
+ "$ref": "DisableServiceRequest"
+ },
+ "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"
+ },
+ "enable": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "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/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/services/{servicesId}:enable",
+ "path": "v1/{+name}:enable",
+ "id": "serviceuser.projects.services.enable",
+ "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",
+ "request": {
+ "$ref": "EnableServiceRequest"
+ }
+ },
+ "list": {
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Token identifying which result to start with; returned by a previous list\ncall.",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Requested size of the next page of data.",
+ "format": "int32"
+ },
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "List enabled services for the specified parent.\n\nAn example valid parent would be:\n- projects/my-project"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "location": "query",
+ "description": "Token identifying which result to start with; returned by a previous list\ncall.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Requested size of the next page of data.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/services:search",
+ "path": "v1/services:search",
+ "id": "serviceuser.services.search"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "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": {
+ "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\")."
+ },
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://serviceuser.googleapis.com/",
+ "servicePath": "",
+ "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.",
"basePath": "",
"revision": "20171208",
"documentationLink": "https://cloud.google.com/service-management/",
@@ -6,6 +236,195 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "Step": {
+ "description": "Represents the status of one operation step.",
+ "type": "object",
+ "properties": {
+ "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"
+ ]
+ },
+ "description": {
+ "description": "The short description of the step.",
+ "type": "string"
+ }
+ },
+ "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": {
+ "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": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ }
+ },
+ "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": {
+ "options": {
+ "description": "Any metadata attached to the method.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ },
+ "responseStreaming": {
+ "description": "If true, the response is streamed.",
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string",
+ "description": "The simple name of this method."
+ },
+ "requestTypeUrl": {
+ "type": "string",
+ "description": "A URL of the input message type."
+ },
+ "requestStreaming": {
+ "description": "If true, the request is streamed.",
+ "type": "boolean"
+ },
+ "syntax": {
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of this method."
+ },
+ "responseTypeUrl": {
+ "description": "The URL of the output message type.",
+ "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": {
+ "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": {
+ "type": "string",
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "values": {
+ "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",
+ "additionalProperties": {
+ "format": "int64",
+ "type": "string"
+ }
+ }
+ },
+ "id": "QuotaLimit"
+ },
"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",
@@ -25,19 +444,19 @@
"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": {
- "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"
- }
- },
"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": {
+ "type": "array",
+ "items": {
+ "$ref": "CustomErrorRule"
+ },
+ "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."
}
},
"id": "CustomError"
@@ -46,16 +465,16 @@
"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"
@@ -68,11 +487,11 @@
"description": "All files used during config generation.",
"type": "array",
"items": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "type": "object"
}
}
},
@@ -94,16 +513,16 @@
"type": "object",
"properties": {
"name": {
- "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
- "type": "string"
+ "type": "string",
+ "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive."
},
"urlQueryParameter": {
"description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
"type": "string"
},
"httpHeader": {
- "type": "string",
- "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive."
+ "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
+ "type": "string"
}
},
"id": "SystemParameter"
@@ -111,11 +530,11 @@
"Monitoring": {
"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"
- },
- "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."
+ }
},
"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.",
@@ -133,10 +552,6 @@
"description": "A single field of a message type.",
"type": "object",
"properties": {
- "name": {
- "type": "string",
- "description": "The field name."
- },
"typeUrl": {
"description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
"type": "string"
@@ -197,21 +612,17 @@
"type": "string"
},
"options": {
- "description": "The protocol buffer options.",
"type": "array",
"items": {
"$ref": "Option"
- }
+ },
+ "description": "The protocol buffer options."
},
"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"
},
- "packed": {
- "description": "Whether to use alternative packed wire representation.",
- "type": "boolean"
- },
"cardinality": {
"enumDescriptions": [
"For fields with unknown cardinality.",
@@ -228,15 +639,22 @@
"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"
},
"Enum": {
- "type": "object",
"properties": {
"name": {
"description": "Enum type name.",
@@ -261,8 +679,6 @@
"description": "The source context."
},
"syntax": {
- "description": "The source syntax.",
- "type": "string",
"enumDescriptions": [
"Syntax `proto2`.",
"Syntax `proto3`."
@@ -270,11 +686,14 @@
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
- ]
+ ],
+ "description": "The source syntax.",
+ "type": "string"
}
},
"id": "Enum",
- "description": "Enum type definition."
+ "description": "Enum type definition.",
+ "type": "object"
},
"EnableServiceRequest": {
"description": "Request message for EnableService method.",
@@ -283,6 +702,7 @@
"id": "EnableServiceRequest"
},
"LabelDescriptor": {
+ "id": "LabelDescriptor",
"description": "A description of a label.",
"type": "object",
"properties": {
@@ -291,31 +711,52 @@
"type": "string"
},
"description": {
- "type": "string",
- "description": "A human-readable description for the label."
+ "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."
+ ],
+ "enum": [
+ "STRING",
+ "BOOL",
+ "INT64"
]
}
- },
- "id": "LabelDescriptor"
+ }
},
"Type": {
- "id": "Type",
"description": "A protocol buffer message type.",
"type": "object",
"properties": {
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "The source context."
+ },
+ "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"
+ }
+ },
"fields": {
"description": "The list of fields.",
"type": "array",
@@ -324,8 +765,8 @@
}
},
"name": {
- "type": "string",
- "description": "The fully qualified message name."
+ "description": "The fully qualified message name.",
+ "type": "string"
},
"oneofs": {
"description": "The list of types appearing in `oneof` definitions in this type.",
@@ -333,31 +774,9 @@
"items": {
"type": "string"
}
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- },
- "syntax": {
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ]
- },
- "options": {
- "description": "The protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
}
- }
+ },
+ "id": "Type"
},
"Experimental": {
"description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
@@ -393,8 +812,8 @@
"type": "string"
},
"deprecationDescription": {
- "type": "string",
- "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`."
+ "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.",
@@ -404,37 +823,37 @@
"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",
"properties": {
"provider": {
- "type": "string",
- "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com."
+ "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com.",
+ "type": "string"
}
},
- "id": "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"
+ "id": "AuthorizationConfig"
},
"ContextRule": {
"description": "A context rule provides information about the context for an individual API\nelement.",
"type": "object",
"properties": {
+ "requested": {
+ "description": "A list of full type names of requested contexts.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
"provided": {
"description": "A list of full type names of provided contexts.",
"type": "array",
"items": {
"type": "string"
}
- },
- "requested": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "A list of full type names of requested contexts."
- },
- "selector": {
- "type": "string",
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details."
}
},
"id": "ContextRule"
@@ -454,10 +873,46 @@
"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": {
+ "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"
+ },
+ "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.\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"
+ },
+ "unit": {
+ "type": "string",
+ "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 '}'."
+ },
+ "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",
+ "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\nURL-encoded. All user-defined custom metric types have the DNS name\n`custom.googleapis.com`. Metric types should use a natural hierarchical\ngrouping. For example:\n\n \"custom.googleapis.com/invoice/paid/amount\"\n \"appengine.googleapis.com/http/server/response_latencies\"",
"type": "string"
@@ -483,50 +938,13 @@
"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 '}'.",
- "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",
- "items": {
- "$ref": "LabelDescriptor"
- }
- },
- "name": {
- "description": "The resource name of the metric descriptor.",
- "type": "string"
}
- }
+ },
+ "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"
},
"SourceContext": {
- "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
"type": "object",
"properties": {
"fileName": {
@@ -534,13 +952,29 @@
"type": "string"
}
},
- "id": "SourceContext"
+ "id": "SourceContext",
+ "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined."
},
"Endpoint": {
- "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",
- "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"
@@ -548,67 +982,44 @@
"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": {
- "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": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The list of features enabled on this endpoint."
- },
- "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",
+ "type": "object"
},
"ListEnabledServicesResponse": {
+ "description": "Response message for `ListEnabledServices` method.",
+ "type": "object",
"properties": {
"services": {
+ "description": "Services enabled for the specified parent.",
"type": "array",
"items": {
"$ref": "PublishedService"
- },
- "description": "Services enabled for the specified parent."
+ }
},
"nextPageToken": {
"description": "Token that can be passed to `ListEnabledServices` to resume a paginated\nquery.",
"type": "string"
}
},
- "id": "ListEnabledServicesResponse",
- "description": "Response message for `ListEnabledServices` method.",
- "type": "object"
+ "id": "ListEnabledServicesResponse"
},
"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",
"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"
}
},
- "id": "OAuthRequirements"
+ "id": "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"
},
"Usage": {
- "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": {
"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"
@@ -619,14 +1030,19 @@
"items": {
"$ref": "UsageRule"
}
+ },
+ "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"
+ }
}
},
- "id": "Usage"
+ "id": "Usage",
+ "description": "Configuration controlling usage of a service."
},
"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.",
@@ -635,7 +1051,10 @@
"$ref": "ContextRule"
}
}
- }
+ },
+ "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"
},
"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",
@@ -709,7 +1128,6 @@
"id": "CustomErrorRule"
},
"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).",
@@ -717,14 +1135,13 @@
}
},
"id": "CustomAuthRequirements",
- "description": "Configuration for a custom authentication provider."
+ "description": "Configuration for a custom authentication provider.",
+ "type": "object"
},
"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": {
- "useDirectDownload": {
- "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.",
- "type": "boolean"
- },
"enabled": {
"description": "Whether download is enabled.",
"type": "boolean"
@@ -745,17 +1162,19 @@
"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",
- "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"
+ "id": "MediaDownload"
},
"DisableServiceRequest": {
- "description": "Request message for DisableService method.",
"type": "object",
"properties": {},
- "id": "DisableServiceRequest"
+ "id": "DisableServiceRequest",
+ "description": "Request message for DisableService method."
},
"SearchServicesResponse": {
"description": "Response message for SearchServices method.",
@@ -769,30 +1188,16 @@
}
},
"nextPageToken": {
- "type": "string",
- "description": "Token that can be passed to `ListAvailableServices` to resume a paginated\nquery."
+ "description": "Token that can be passed to `ListAvailableServices` to resume a paginated\nquery.",
+ "type": "string"
}
},
"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": {
- "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"
@@ -801,81 +1206,91 @@
"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",
- "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": {
- "metrics": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Names of the metrics to report to this billing destination.\nEach name must be defined in Service.metrics section."
},
- "monitoredResource": {
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
+ "maxSize": {
+ "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.",
+ "format": "int64",
+ "type": "string"
+ },
+ "enabled": {
+ "description": "Whether upload is enabled.",
+ "type": "boolean"
+ },
+ "progressNotification": {
+ "description": "Whether to receive a notification for progress changes of media upload.",
+ "type": "boolean"
+ },
+ "completeNotification": {
+ "type": "boolean",
+ "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."
+ },
+ "dropzone": {
+ "description": "Name of the Scotty dropzone to use for the current API.",
"type": "string"
}
},
- "id": "BillingDestination"
+ "id": "MediaUpload"
+ },
+ "BillingDestination": {
+ "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",
+ "description": "Configuration of a specific billing destination (Currently only support\nbill against consumer project).",
+ "type": "object"
},
"UsageRule": {
+ "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",
"properties": {
+ "allowUnregisteredCalls": {
+ "description": "True, if the method allows unregistered calls; false otherwise.",
+ "type": "boolean"
+ },
"selector": {
- "type": "string",
- "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details."
+ "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": "True, if the method should skip service control. If so, no control plane\nfeature (like quota and billing) will be enabled.\nThis flag is used by ESP to allow some Endpoints customers to bypass\nGoogle internal checks.",
"type": "boolean"
- },
- "allowUnregisteredCalls": {
- "description": "True, if the method allows unregistered calls; false otherwise.",
- "type": "boolean"
- }
- },
- "id": "UsageRule"
- },
- "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).",
- "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"
}
}
},
+ "AuthRequirement": {
+ "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",
+ "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"
+ },
"Documentation": {
"properties": {
- "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"
@@ -888,15 +1303,19 @@
}
},
"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."
+ "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"
- },
- "description": "The top level pages for the documentation set."
+ }
+ },
+ "summary": {
+ "description": "A short summary of what the service does. Can only be provided by\nplain text.",
+ "type": "string"
}
},
"id": "Documentation",
@@ -929,39 +1348,66 @@
"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": {
- "requirements": {
- "description": "Requirements for additional authentication providers.",
- "type": "array",
- "items": {
- "$ref": "AuthRequirement"
- }
- },
"selector": {
- "type": "string",
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details."
+ "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": {
- "$ref": "OAuthRequirements",
- "description": "The requirements for OAuth credentials."
+ "description": "The requirements for OAuth credentials.",
+ "$ref": "OAuthRequirements"
},
"customAuth": {
- "description": "Configuration for custom authentication.",
- "$ref": "CustomAuthRequirements"
+ "$ref": "CustomAuthRequirements",
+ "description": "Configuration for custom authentication."
+ },
+ "requirements": {
+ "description": "Requirements for additional authentication providers.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthRequirement"
+ }
}
},
- "id": "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."
},
"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": {
+ "syntax": {
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of the service."
+ },
+ "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",
@@ -979,33 +1425,6 @@
"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": {
- "type": "string",
- "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"
- },
- "mixins": {
- "description": "Included interfaces. See Mixin.",
- "type": "array",
- "items": {
- "$ref": "Mixin"
- }
}
},
"id": "Api"
@@ -1019,17 +1438,19 @@
"type": "string"
},
"metricCosts": {
+ "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",
"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"
},
"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.",
@@ -1046,25 +1467,12 @@
}
}
},
- "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": {
+ "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"
@@ -1075,20 +1483,39 @@
},
"metadata": {
"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."
},
"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",
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call."
+ "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"
@@ -1096,26 +1523,13 @@
"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"
- }
}
- },
- "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"
@@ -1124,12 +1538,17 @@
"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"
@@ -1138,10 +1557,6 @@
"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"
@@ -1157,6 +1572,10 @@
"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": {
+ "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"
}
},
"id": "AuthProvider"
@@ -1165,61 +1584,9 @@
"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": {
- "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."
- },
- "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": {
- "description": "API visibility configuration.",
- "$ref": "Visibility"
- },
- "quota": {
- "description": "Quota configuration.",
- "$ref": "Quota"
- },
- "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": {
- "description": "Custom error configuration.",
- "$ref": "CustomError"
- },
"title": {
- "description": "The product title for this service.",
- "type": "string"
+ "type": "string",
+ "description": "The product title for this service."
},
"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.",
@@ -1228,13 +1595,6 @@
"$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",
@@ -1242,6 +1602,13 @@
"$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",
@@ -1266,20 +1633,20 @@
"description": "System parameter configuration."
},
"documentation": {
- "$ref": "Documentation",
- "description": "Additional API documentation."
- },
- "monitoredResources": {
- "type": "array",
- "items": {
- "$ref": "MonitoredResourceDescriptor"
- },
- "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations."
+ "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",
@@ -1296,8 +1663,8 @@
"type": "string"
},
"usage": {
- "$ref": "Usage",
- "description": "Configuration controlling usage of this service."
+ "description": "Configuration controlling usage of this service.",
+ "$ref": "Usage"
},
"metrics": {
"description": "Defines the metrics used by this service.",
@@ -1305,13 +1672,63 @@
"items": {
"$ref": "MetricDescriptor"
}
+ },
+ "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": {
+ "description": "Monitoring configuration.",
+ "$ref": "Monitoring"
+ },
+ "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": {
+ "$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": {
+ "description": "Billing configuration.",
+ "$ref": "Billing"
+ },
+ "customError": {
+ "$ref": "CustomError",
+ "description": "Custom error configuration."
}
},
"id": "Service"
},
"EnumValue": {
- "description": "Enum value definition.",
- "type": "object",
"properties": {
"options": {
"description": "Protocol buffer options.",
@@ -1321,39 +1738,38 @@
}
},
"number": {
- "type": "integer",
"description": "Enum value number.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"name": {
"description": "Enum value name.",
"type": "string"
}
},
- "id": "EnumValue"
+ "id": "EnumValue",
+ "description": "Enum value definition.",
+ "type": "object"
},
"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"
+ },
+ "kind": {
+ "description": "The name of this custom HTTP verb.",
+ "type": "string"
}
},
"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",
@@ -1372,11 +1788,14 @@
"description": "Percentage of completion of this operation, ranging from 0 to 100.",
"format": "int32",
"type": "integer"
+ },
+ "startTime": {
+ "type": "string",
+ "description": "The start time of the operation.",
+ "format": "google-datetime"
}
},
- "id": "OperationMetadata",
- "description": "The metadata associated with a long running operation resource.",
- "type": "object"
+ "id": "OperationMetadata"
},
"PublishedService": {
"description": "The published version of a Service that is managed by\nGoogle Service Management.",
@@ -1387,29 +1806,87 @@
"description": "The service's published configuration."
},
"name": {
- "type": "string",
- "description": "The resource name of the service.\n\nA valid name would be:\n- services/serviceuser.googleapis.com"
+ "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.",
"type": "object",
"properties": {
- "parameters": {
- "type": "array",
- "items": {
- "$ref": "SystemParameter"
- },
- "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."
- },
"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",
- "description": "Define a system parameter rule mapping system parameter definitions to\nmethods."
+ "id": "SystemParameterRule"
+ },
+ "HttpRule": {
+ "type": "object",
+ "properties": {
+ "additionalBindings": {
+ "type": "array",
+ "items": {
+ "$ref": "HttpRule"
+ },
+ "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)."
+ },
+ "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."
+ },
+ "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": {
+ "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"
+ }
+ },
+ "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."
},
"VisibilityRule": {
"description": "A visibility rule provides visibility configuration for an individual API\nelement.",
@@ -1426,81 +1903,23 @@
},
"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": {
- "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": {
- "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": {
- "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": {
- "type": "string",
- "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."
- }
- },
- "id": "HttpRule"
- },
"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"
}
- },
- "monitoredResource": {
- "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.",
- "type": "string"
}
- }
+ },
+ "id": "MonitoringDestination"
},
"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.",
@@ -1531,221 +1950,32 @@
"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": {
- "metricRules": {
- "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics.",
- "type": "array",
- "items": {
- "$ref": "MetricRule"
- }
- },
"limits": {
"description": "List of `QuotaLimit` definitions for the service.",
"type": "array",
"items": {
"$ref": "QuotaLimit"
}
- }
- },
- "id": "Quota"
- },
- "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"
- },
- "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 \"/\".",
+ "metricRules": {
+ "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics.",
"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": {
- "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",
- "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc."
- },
- "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"
+ "$ref": "MetricRule"
}
}
},
- "id": "Logging"
- },
- "Method": {
- "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": {
- "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": {
- "type": "boolean",
- "description": "If true, the response is streamed."
- }
- },
- "id": "Method",
- "description": "Method represents a method of an API interface.",
+ "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"
- },
- "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": {
- "type": "string",
- "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"
- },
- "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"
- }
- },
- "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"
- },
"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": "Service User",
"auth": {
"oauth2": {
@@ -1767,235 +1997,5 @@
"name": "serviceuser",
"batchPath": "batch",
"title": "Google Service User API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "services": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListEnabledServicesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "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"
- },
- "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/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectsId}/services",
- "path": "v1/{+parent}/services",
- "id": "serviceuser.projects.services.list",
- "description": "List enabled services for the specified consumer."
- },
- "disable": {
- "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",
- "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": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/services/[^/]+$",
- "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"
- }
- },
- "flatPath": "v1/projects/{projectsId}/services/{servicesId}:enable",
- "path": "v1/{+name}:enable",
- "id": "serviceuser.projects.services.enable",
- "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",
- "request": {
- "$ref": "EnableServiceRequest"
- }
- }
- }
- }
- }
- },
- "services": {
- "methods": {
- "search": {
- "flatPath": "v1/services:search",
- "path": "v1/services:search",
- "id": "serviceuser.services.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": {
- "type": "string",
- "location": "query",
- "description": "Token identifying which result to start with; returned by a previous list\ncall."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Requested size of the next page of data.",
- "format": "int32"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "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"
- },
- "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"
- },
- "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": {
- "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"
- }
- },
- "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": ""
+ "ownerName": "Google"
}
diff --git a/sheets/v4/sheets-api.json b/sheets/v4/sheets-api.json
index 9c5ff14..847b1f3 100644
--- a/sheets/v4/sheets-api.json
+++ b/sheets/v4/sheets-api.json
@@ -1,788 +1,4 @@
{
- "resources": {
- "spreadsheets": {
- "methods": {
- "create": {
- "request": {
- "$ref": "Spreadsheet"
- },
- "description": "Creates a spreadsheet, returning the newly created spreadsheet.",
- "response": {
- "$ref": "Spreadsheet"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets",
- "path": "v4/spreadsheets",
- "id": "sheets.spreadsheets.create"
- },
- "batchUpdate": {
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "BatchUpdateSpreadsheetResponse"
- },
- "parameters": {
- "spreadsheetId": {
- "description": "The spreadsheet 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/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
- "id": "sheets.spreadsheets.batchUpdate",
- "path": "v4/spreadsheets/{spreadsheetId}:batchUpdate"
- },
- "get": {
- "response": {
- "$ref": "Spreadsheet"
- },
- "parameterOrder": [
- "spreadsheetId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "ranges": {
- "repeated": true,
- "location": "query",
- "description": "The ranges to retrieve from the spreadsheet.",
- "type": "string"
- },
- "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"
- ],
- "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": {
- "id": "sheets.spreadsheets.getByDataFilter",
- "path": "v4/spreadsheets/{spreadsheetId}:getByDataFilter",
- "request": {
- "$ref": "GetSpreadsheetByDataFilterRequest"
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "Spreadsheet"
- },
- "parameters": {
- "spreadsheetId": {
- "description": "The spreadsheet to request.",
- "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}:getByDataFilter"
- }
- },
- "resources": {
- "sheets": {
- "methods": {
- "copyTo": {
- "response": {
- "$ref": "SheetProperties"
- },
- "parameterOrder": [
- "spreadsheetId",
- "sheetId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "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": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}: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": {
- "get": {
- "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}",
- "id": "sheets.spreadsheets.developerMetadata.get",
- "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}",
- "description": "Returns the developer metadata with the specified ID.\nThe caller must specify the spreadsheet ID and the developer metadata's\nunique metadataId.",
- "httpMethod": "GET",
- "response": {
- "$ref": "DeveloperMetadata"
- },
- "parameterOrder": [
- "spreadsheetId",
- "metadataId"
- ],
- "parameters": {
- "metadataId": {
- "description": "The ID of the developer metadata to retrieve.",
- "format": "int32",
- "required": true,
- "type": "integer",
- "location": "path"
- },
- "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"
- ]
- },
- "search": {
- "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search",
- "id": "sheets.spreadsheets.developerMetadata.search",
- "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.",
- "request": {
- "$ref": "SearchDeveloperMetadataRequest"
- },
- "response": {
- "$ref": "SearchDeveloperMetadataResponse"
- },
- "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 metadata from.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search"
- }
- }
- },
- "values": {
- "methods": {
- "batchGet": {
- "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.",
- "response": {
- "$ref": "BatchGetValuesResponse"
- },
- "parameterOrder": [
- "spreadsheetId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to retrieve data from.",
- "required": true,
- "type": "string"
- },
- "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": {
- "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]."
- },
- "ranges": {
- "repeated": true,
- "location": "query",
- "description": "The A1 notation of the values to retrieve.",
- "type": "string"
- },
- "majorDimension": {
- "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",
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ]
- }
- },
- "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"
- ]
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "response": {
- "$ref": "ClearValuesResponse"
- },
- "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"
- }
- },
- "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/{range}:clear",
- "id": "sheets.spreadsheets.values.clear",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear"
- },
- "batchClearByDataFilter": {
- "response": {
- "$ref": "BatchClearValuesByDataFilterResponse"
- },
- "parameterOrder": [
- "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:batchClearByDataFilter",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter",
- "id": "sheets.spreadsheets.values.batchClearByDataFilter",
- "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."
- },
- "append": {
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.file",
- "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": {
- "required": true,
- "type": "string",
- "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."
- },
- "spreadsheetId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the spreadsheet to update."
- },
- "responseValueRenderOption": {
- "location": "query",
- "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"
- },
- "insertDataOption": {
- "description": "How the input data should be inserted.",
- "type": "string",
- "location": "query",
- "enum": [
- "OVERWRITE",
- "INSERT_ROWS"
- ]
- },
- "valueInputOption": {
- "location": "query",
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ],
- "description": "How the input data should be interpreted.",
- "type": "string"
- },
- "responseDateTimeRenderOption": {
- "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].",
- "type": "string"
- }
- },
- "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"
- },
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "httpMethod": "POST"
- },
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "BatchGetValuesByDataFilterResponse"
- },
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to retrieve data from.",
- "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:batchGetByDataFilter",
- "id": "sheets.spreadsheets.values.batchGetByDataFilter",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter"
- },
- "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": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
- "id": "sheets.spreadsheets.values.batchClear"
- },
- "get": {
- "description": "Returns a range of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and a range.",
- "response": {
- "$ref": "ValueRange"
- },
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "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": {
- "location": "path",
- "description": "The A1 notation of the values to retrieve.",
- "required": true,
- "type": "string"
- },
- "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": {
- "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",
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ]
- },
- "majorDimension": {
- "type": "string",
- "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]]`."
- },
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to retrieve data from.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "id": "sheets.spreadsheets.values.get"
- },
- "batchUpdateByDataFilter": {
- "response": {
- "$ref": "BatchUpdateValuesByDataFilterResponse"
- },
- "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 update.",
- "required": true,
- "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"
- }
- },
- "update": {
- "id": "sheets.spreadsheets.values.update",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "request": {
- "$ref": "ValueRange"
- },
- "description": "Sets values in a range of a spreadsheet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "response": {
- "$ref": "UpdateValuesResponse"
- },
- "parameters": {
- "responseDateTimeRenderOption": {
- "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].",
- "type": "string"
- },
- "range": {
- "location": "path",
- "description": "The A1 notation of the values to update.",
- "required": true,
- "type": "string"
- },
- "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"
- },
- "responseValueRenderOption": {
- "location": "query",
- "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"
- },
- "valueInputOption": {
- "location": "query",
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ],
- "description": "How the input data should be interpreted.",
- "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/{range}"
- },
- "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"
- },
- "response": {
- "$ref": "BatchUpdateValuesResponse"
- },
- "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": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the spreadsheet to update."
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
- "id": "sheets.spreadsheets.values.batchUpdate"
- }
- }
- }
- }
- }
- },
- "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"
- },
- "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": {
- "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": {
- "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"
- }
- },
- "version": "v4",
- "baseUrl": "https://sheets.googleapis.com/",
"kind": "discovery#restDescription",
"description": "Reads and writes Google Sheets.",
"servicePath": "",
@@ -793,26 +9,3755 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "FilterView": {
- "id": "FilterView",
- "description": "A filter view.",
- "type": "object",
+ "ExtendedValue": {
"properties": {
- "range": {
- "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
- "$ref": "GridRange"
+ "numberValue": {
+ "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format.",
+ "format": "double",
+ "type": "number"
},
- "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"
+ "errorValue": {
+ "description": "Represents an error.\nThis field is read-only.",
+ "$ref": "ErrorValue"
},
- "title": {
- "description": "The name of the filter view.",
+ "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\"`.",
"type": "string"
},
+ "boolValue": {
+ "description": "Represents a boolean value.",
+ "type": "boolean"
+ },
+ "formulaValue": {
+ "description": "Represents a formula.",
+ "type": "string"
+ }
+ },
+ "id": "ExtendedValue",
+ "description": "The kinds of value that a cell in a spreadsheet can have.",
+ "type": "object"
+ },
+ "BandedRange": {
+ "properties": {
+ "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."
+ },
+ "range": {
+ "description": "The range over which these properties are applied.",
+ "$ref": "GridRange"
+ }
+ },
+ "id": "BandedRange",
+ "description": "A banded (alternating colors) range in a sheet.",
+ "type": "object"
+ },
+ "HistogramSeries": {
+ "description": "A histogram series containing the series color and data.",
+ "type": "object",
+ "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"
+ },
+ "BatchClearValuesResponse": {
+ "description": "The response when clearing a range of values in a spreadsheet.",
+ "type": "object",
+ "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"
+ },
+ "Spreadsheet": {
+ "description": "Resource that represents a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "description": "Overall properties of a spreadsheet.",
+ "$ref": "SpreadsheetProperties"
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet.\nThis field is read-only.",
+ "type": "string"
+ },
+ "namedRanges": {
+ "description": "The named ranges defined in a spreadsheet.",
+ "type": "array",
+ "items": {
+ "$ref": "NamedRange"
+ }
+ },
+ "developerMetadata": {
+ "description": "The developer metadata associated with a spreadsheet.",
+ "type": "array",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "Spreadsheet"
+ },
+ "AddChartRequest": {
+ "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"
+ }
+ },
+ "id": "AddChartRequest",
+ "description": "Adds a chart to a sheet in the spreadsheet.",
+ "type": "object"
+ },
+ "UpdateProtectedRangeRequest": {
+ "properties": {
+ "protectedRange": {
+ "$ref": "ProtectedRange",
+ "description": "The protected range to update with the new properties."
+ },
+ "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.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "UpdateProtectedRangeRequest",
+ "description": "Updates an existing protected range with the specified\nprotectedRangeId.",
+ "type": "object"
+ },
+ "DataFilter": {
+ "properties": {
+ "a1Range": {
+ "description": "Selects data that matches the specified A1 range.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "DataFilter",
+ "description": "Filter that describes what data should be selected or returned from a\nrequest.",
+ "type": "object"
+ },
+ "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": {
+ "$ref": "Color",
+ "description": "The foreground color of the text."
+ },
+ "bold": {
+ "description": "True if the text is bold.",
+ "type": "boolean"
+ },
+ "fontFamily": {
+ "description": "The font family.",
+ "type": "string"
+ },
+ "strikethrough": {
+ "description": "True if the text has a strikethrough.",
+ "type": "boolean"
+ },
+ "italic": {
+ "description": "True if the text is italicized.",
+ "type": "boolean"
+ },
+ "fontSize": {
+ "description": "The size of the font.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "TextFormat"
+ },
+ "AddSheetResponse": {
+ "properties": {
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties of the newly added sheet."
+ }
+ },
+ "id": "AddSheetResponse",
+ "description": "The result of adding a sheet.",
+ "type": "object"
+ },
+ "AddFilterViewResponse": {
+ "properties": {
+ "filter": {
+ "$ref": "FilterView",
+ "description": "The newly added filter view."
+ }
+ },
+ "id": "AddFilterViewResponse",
+ "description": "The result of adding a filter view.",
+ "type": "object"
+ },
+ "IterativeCalculationSettings": {
+ "properties": {
+ "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",
+ "description": "Settings to control how circular dependencies are resolved with iterative\ncalculation.",
+ "type": "object"
+ },
+ "SpreadsheetProperties": {
+ "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"
+ },
+ "timeZone": {
+ "description": "The time zone of the spreadsheet, in CLDR format such as\n`America/New_York`. If the time zone isn't recognized, this may\nbe a custom time zone such as `GMT-07:00`.",
+ "type": "string"
+ },
+ "locale": {
+ "description": "The locale of the spreadsheet in one of the following formats:\n\n* an ISO 639-1 language code such as `en`\n\n* an ISO 639-2 language code such as `fil`, if no 639-1 code exists\n\n* a combination of the ISO language code and country code, such as `en_US`\n\nNote: when updating this field, not all locales/languages are supported.",
+ "type": "string"
+ },
+ "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."
+ }
+ },
+ "id": "SpreadsheetProperties",
+ "description": "Properties of a spreadsheet.",
+ "type": "object"
+ },
+ "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": {
+ "$ref": "GridCoordinate",
+ "description": "The cell the object is anchored to."
+ },
+ "offsetYPixels": {
+ "description": "The vertical offset, in pixels, that the object is offset\nfrom the anchor cell.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "heightPixels": {
+ "description": "The height of the object, in pixels. Defaults to 371.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "OverlayPosition"
+ },
+ "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": {
+ "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": {
+ "$ref": "CellData",
+ "description": "The data to write."
+ },
+ "range": {
+ "description": "The range to repeat the cell in.",
+ "$ref": "GridRange"
+ }
+ },
+ "id": "RepeatCellRequest"
+ },
+ "AddChartResponse": {
+ "properties": {
+ "chart": {
+ "$ref": "EmbeddedChart",
+ "description": "The newly added chart."
+ }
+ },
+ "id": "AddChartResponse",
+ "description": "The result of adding a chart to a spreadsheet.",
+ "type": "object"
+ },
+ "InsertDimensionRequest": {
+ "properties": {
+ "range": {
+ "$ref": "DimensionRange",
+ "description": "The dimensions to insert. Both the start and end indexes must be bounded."
+ },
+ "inheritFromBefore": {
+ "description": "Whether dimension properties should be extended from the dimensions\nbefore or after the newly inserted dimensions.\nTrue to inherit from the dimensions before (in which case the start\nindex must be greater than 0), and false to inherit from the dimensions\nafter.\n\nFor example, if row index 0 has red background and row index 1\nhas a green background, then inserting 2 rows at index 1 can inherit\neither the green or red background. If `inheritFromBefore` is true,\nthe two new rows will be red (because the row before the insertion point\nwas red), whereas if `inheritFromBefore` is false, the two new rows will\nbe green (because the row after the insertion point was green).",
+ "type": "boolean"
+ }
+ },
+ "id": "InsertDimensionRequest",
+ "description": "Inserts rows or columns in a sheet at a particular index.",
+ "type": "object"
+ },
+ "UpdateSpreadsheetPropertiesRequest": {
+ "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"
+ }
+ },
+ "id": "UpdateSpreadsheetPropertiesRequest"
+ },
+ "ProtectedRange": {
+ "description": "A protected range.",
+ "type": "object",
+ "properties": {
+ "unprotectedRanges": {
+ "description": "The list of unprotected ranges within a protected sheet.\nUnprotected ranges are only supported on protected sheets.",
+ "type": "array",
+ "items": {
+ "$ref": "GridRange"
+ }
+ },
+ "namedRangeId": {
+ "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ },
+ "BatchUpdateValuesRequest": {
+ "description": "The request for updating more than one range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "ValueRange"
+ }
+ },
+ "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"
+ },
+ "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\"`."
+ ],
+ "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"
+ }
+ },
+ "id": "BatchUpdateValuesRequest"
+ },
+ "DimensionProperties": {
+ "description": "Properties about a dimension.",
+ "type": "object",
+ "properties": {
+ "developerMetadata": {
+ "description": "The developer metadata associated with a single row or column.",
+ "type": "array",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ }
+ },
+ "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"
+ },
+ "hiddenByUser": {
+ "description": "True if this dimension is explicitly hidden.",
+ "type": "boolean"
+ }
+ },
+ "id": "DimensionProperties"
+ },
+ "DimensionRange": {
+ "properties": {
+ "sheetId": {
+ "description": "The sheet this span is on.",
+ "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": "The dimension of the span.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The start (inclusive) of the span, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "endIndex": {
+ "description": "The end (exclusive) of the span, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DimensionRange",
+ "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"
+ },
+ "NamedRange": {
+ "description": "A named range.",
+ "type": "object",
+ "properties": {
+ "namedRangeId": {
+ "description": "The ID of the named range.",
+ "type": "string"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range this represents."
+ },
+ "name": {
+ "description": "The name of the named range.",
+ "type": "string"
+ }
+ },
+ "id": "NamedRange"
+ },
+ "CutPasteRequest": {
+ "description": "Moves data from the source to the destination.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "GridRange",
+ "description": "The source data to cut."
+ },
+ "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. 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.",
+ "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."
+ ]
+ },
+ "destination": {
+ "description": "The top-left coordinate where the data should be pasted.",
+ "$ref": "GridCoordinate"
+ }
+ },
+ "id": "CutPasteRequest"
+ },
+ "Borders": {
+ "description": "The borders of the cell.",
+ "type": "object",
+ "properties": {
+ "right": {
+ "description": "The right border of the cell.",
+ "$ref": "Border"
+ },
+ "bottom": {
+ "description": "The bottom border of the cell.",
+ "$ref": "Border"
+ },
+ "top": {
+ "description": "The top border of the cell.",
+ "$ref": "Border"
+ },
+ "left": {
+ "description": "The left border of the cell.",
+ "$ref": "Border"
+ }
+ },
+ "id": "Borders"
+ },
+ "BasicChartSeries": {
+ "properties": {
+ "targetAxis": {
+ "enum": [
+ "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
+ "BOTTOM_AXIS",
+ "LEFT_AXIS",
+ "RIGHT_AXIS"
+ ],
+ "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.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
+ "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
+ "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
+ ]
+ },
+ "series": {
+ "description": "The data being visualized in this chart series.",
+ "$ref": "ChartData"
+ },
+ "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",
+ "LINE",
+ "AREA",
+ "COLUMN",
+ "SCATTER",
+ "COMBO",
+ "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"
+ }
+ },
+ "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"
+ },
+ "AutoResizeDimensionsRequest": {
+ "properties": {
+ "dimensions": {
+ "description": "The dimensions to automatically resize.",
+ "$ref": "DimensionRange"
+ }
+ },
+ "id": "AutoResizeDimensionsRequest",
+ "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
+ "type": "object"
+ },
+ "UpdateBordersRequest": {
+ "properties": {
+ "bottom": {
+ "$ref": "Border",
+ "description": "The border to put at the bottom of the range."
+ },
+ "innerVertical": {
+ "description": "The vertical border to put within the range.",
+ "$ref": "Border"
+ },
+ "right": {
+ "$ref": "Border",
+ "description": "The border to put at the right of the range."
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range whose borders should be updated."
+ },
+ "innerHorizontal": {
+ "description": "The horizontal border to put within the range.",
+ "$ref": "Border"
+ },
+ "top": {
+ "$ref": "Border",
+ "description": "The border to put at the top of the range."
+ },
+ "left": {
+ "$ref": "Border",
+ "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"
+ },
+ "CellFormat": {
+ "properties": {
+ "wrapStrategy": {
+ "enum": [
+ "WRAP_STRATEGY_UNSPECIFIED",
+ "OVERFLOW_CELL",
+ "LEGACY_WRAP",
+ "CLIP",
+ "WRAP"
+ ],
+ "description": "The wrap strategy for the value in the cell.",
+ "type": "string",
+ "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. |"
+ ]
+ },
+ "textRotation": {
+ "$ref": "TextRotation",
+ "description": "The rotation applied to text in a cell"
+ },
+ "numberFormat": {
+ "$ref": "NumberFormat",
+ "description": "A format describing how number values should be represented to the user."
+ },
+ "hyperlinkDisplayType": {
+ "enum": [
+ "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
+ "LINKED",
+ "PLAIN_TEXT"
+ ],
+ "description": "How a hyperlink, if it exists, should be displayed in the cell.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value: the hyperlink is rendered. Do not use this.",
+ "A hyperlink should be explicitly rendered.",
+ "A hyperlink should not be rendered."
+ ]
+ },
+ "horizontalAlignment": {
+ "enumDescriptions": [
+ "The horizontal alignment is not specified. Do not use this.",
+ "The text is explicitly aligned to the left of the cell.",
+ "The text is explicitly aligned to the center of the cell.",
+ "The text is explicitly aligned to the right of the cell."
+ ],
+ "enum": [
+ "HORIZONTAL_ALIGN_UNSPECIFIED",
+ "LEFT",
+ "CENTER",
+ "RIGHT"
+ ],
+ "description": "The horizontal alignment of the value in the cell.",
+ "type": "string"
+ },
+ "textFormat": {
+ "$ref": "TextFormat",
+ "description": "The format of the text in the cell (unless overridden by a format run)."
+ },
+ "backgroundColor": {
+ "$ref": "Color",
+ "description": "The background color of the cell."
+ },
+ "padding": {
+ "$ref": "Padding",
+ "description": "The padding of the cell."
+ },
+ "verticalAlignment": {
+ "enumDescriptions": [
+ "The vertical alignment is not specified. Do not use this.",
+ "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"
+ ],
+ "description": "The vertical alignment of the value in the cell.",
+ "type": "string"
+ },
+ "borders": {
+ "$ref": "Borders",
+ "description": "The borders of the cell."
+ },
+ "textDirection": {
+ "enumDescriptions": [
+ "The text direction is not specified. Do not use this.",
+ "The text direction of left-to-right was set by the user.",
+ "The text direction of right-to-left was set by the user."
+ ],
+ "enum": [
+ "TEXT_DIRECTION_UNSPECIFIED",
+ "LEFT_TO_RIGHT",
+ "RIGHT_TO_LEFT"
+ ],
+ "description": "The direction of the text in the cell.",
+ "type": "string"
+ }
+ },
+ "id": "CellFormat",
+ "description": "The format of a cell.",
+ "type": "object"
+ },
+ "ClearValuesResponse": {
+ "properties": {
+ "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",
+ "description": "The response when clearing a range of values in a spreadsheet.",
+ "type": "object"
+ },
+ "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The sheet the rule is being deleted from.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteConditionalFormatRuleRequest"
+ },
+ "AddBandingResponse": {
+ "properties": {
+ "bandedRange": {
+ "$ref": "BandedRange",
+ "description": "The banded range that was added."
+ }
+ },
+ "id": "AddBandingResponse",
+ "description": "The result of adding a banded range.",
+ "type": "object"
+ },
+ "DeleteNamedRangeRequest": {
+ "properties": {
+ "namedRangeId": {
+ "description": "The ID of the named range to delete.",
+ "type": "string"
+ }
+ },
+ "id": "DeleteNamedRangeRequest",
+ "description": "Removes the named range with the given ID from the spreadsheet.",
+ "type": "object"
+ },
+ "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": {
+ "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"
+ },
+ "UpdateBandingRequest": {
+ "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"
+ }
+ },
+ "id": "UpdateBandingRequest",
+ "description": "Updates properties of the supplied banded range.",
+ "type": "object"
+ },
+ "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": {
+ "properties": {
+ "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"
+ }
+ },
+ "sortOrder": {
+ "enum": [
+ "SORT_ORDER_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "description": "The order the values in this group should be sorted.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use this.",
+ "Sort ascending.",
+ "Sort 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"
+ }
+ },
+ "id": "PivotGroup",
+ "description": "A single grouping (either row or column) in a pivot table.",
+ "type": "object"
+ },
+ "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": {
+ "description": "The range the pivot table is reading data from.",
+ "$ref": "GridRange"
+ },
+ "columns": {
+ "description": "Each column grouping in the pivot table.",
+ "type": "array",
+ "items": {
+ "$ref": "PivotGroup"
+ }
+ }
+ },
+ "id": "PivotTable"
+ },
+ "ChartSourceRange": {
+ "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",
+ "description": "Source ranges for a chart.",
+ "type": "object"
+ },
+ "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": {
+ "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"
+ },
+ "AppendCellsRequest": {
+ "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",
+ "description": "Adds new cells after the last row with data in a sheet,\ninserting new rows into the sheet if necessary.",
+ "type": "object"
+ },
+ "AddBandingRequest": {
+ "description": "Adds a new banded range to the spreadsheet.",
+ "type": "object",
+ "properties": {
+ "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.)",
+ "$ref": "BandedRange"
+ }
+ },
+ "id": "AddBandingRequest"
+ },
+ "Response": {
+ "description": "A single response from an update.",
+ "type": "object",
+ "properties": {
+ "findReplace": {
+ "description": "A reply from doing a find/replace.",
+ "$ref": "FindReplaceResponse"
+ },
+ "addSheet": {
+ "description": "A reply from adding a sheet.",
+ "$ref": "AddSheetResponse"
+ },
+ "createDeveloperMetadata": {
+ "description": "A reply from creating a developer metadata entry.",
+ "$ref": "CreateDeveloperMetadataResponse"
+ },
+ "updateConditionalFormatRule": {
+ "description": "A reply from updating a conditional format rule.",
+ "$ref": "UpdateConditionalFormatRuleResponse"
+ },
+ "addNamedRange": {
+ "description": "A reply from adding a named range.",
+ "$ref": "AddNamedRangeResponse"
+ },
+ "deleteDeveloperMetadata": {
+ "description": "A reply from deleting a developer metadata entry.",
+ "$ref": "DeleteDeveloperMetadataResponse"
+ },
+ "addFilterView": {
+ "$ref": "AddFilterViewResponse",
+ "description": "A reply from adding a filter view."
+ },
+ "addBanding": {
+ "$ref": "AddBandingResponse",
+ "description": "A reply from adding a banded range."
+ },
+ "addProtectedRange": {
+ "description": "A reply from adding a protected range.",
+ "$ref": "AddProtectedRangeResponse"
+ },
+ "duplicateSheet": {
+ "$ref": "DuplicateSheetResponse",
+ "description": "A reply from duplicating a sheet."
+ },
+ "deleteConditionalFormatRule": {
+ "description": "A reply from deleting a conditional format rule.",
+ "$ref": "DeleteConditionalFormatRuleResponse"
+ },
+ "updateEmbeddedObjectPosition": {
+ "$ref": "UpdateEmbeddedObjectPositionResponse",
+ "description": "A reply from updating an embedded object's position."
+ },
+ "duplicateFilterView": {
+ "description": "A reply from duplicating a filter view.",
+ "$ref": "DuplicateFilterViewResponse"
+ },
+ "addChart": {
+ "$ref": "AddChartResponse",
+ "description": "A reply from adding a chart."
+ },
+ "updateDeveloperMetadata": {
+ "$ref": "UpdateDeveloperMetadataResponse",
+ "description": "A reply from updating a developer metadata entry."
+ }
+ },
+ "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": {
+ "$ref": "TextFormat",
+ "description": "The format of this run. Absent values inherit the cell's format."
+ },
+ "startIndex": {
+ "description": "The character index where this run starts.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "TextFormatRun"
+ },
+ "InsertRangeRequest": {
+ "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",
+ "description": "Inserts cells into a range, shifting the existing cells over or down.",
+ "type": "object"
+ },
+ "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": {
+ "responses": {
+ "description": "The response for each range updated.",
+ "type": "array",
+ "items": {
+ "$ref": "UpdateValuesByDataFilterResponse"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "BatchUpdateValuesByDataFilterResponse"
+ },
+ "RowData": {
+ "properties": {
+ "values": {
+ "description": "The values in the row, one per column.",
+ "type": "array",
+ "items": {
+ "$ref": "CellData"
+ }
+ }
+ },
+ "id": "RowData",
+ "description": "Data about each cell in a row.",
+ "type": "object"
+ },
+ "Border": {
+ "description": "A border along a cell.",
+ "type": "object",
+ "properties": {
+ "color": {
+ "description": "The color of the border.",
+ "$ref": "Color"
+ },
+ "width": {
+ "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "style": {
+ "enum": [
+ "STYLE_UNSPECIFIED",
+ "DOTTED",
+ "DASHED",
+ "SOLID",
+ "SOLID_MEDIUM",
+ "SOLID_THICK",
+ "NONE",
+ "DOUBLE"
+ ],
+ "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."
+ ]
+ }
+ },
+ "id": "Border"
+ },
+ "GridData": {
+ "description": "Data in the grid, as well as metadata about the dimensions.",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "GridData"
+ },
+ "UpdateNamedRangeRequest": {
+ "description": "Updates properties of the named range with the specified\nnamedRangeId.",
+ "type": "object",
+ "properties": {
+ "namedRange": {
+ "description": "The named range to update with the new properties.",
+ "$ref": "NamedRange"
+ },
+ "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"
+ },
+ "FindReplaceRequest": {
+ "properties": {
+ "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"
+ },
+ "range": {
+ "description": "The range to find/replace over.",
+ "$ref": "GridRange"
+ },
+ "sheetId": {
+ "description": "The sheet to find/replace over.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "FindReplaceRequest",
+ "description": "Finds and replaces data in cells over a range, sheet, or all sheets.",
+ "type": "object"
+ },
+ "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": {
+ "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"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "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."
+ },
+ "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"
+ },
+ "DeleteConditionalFormatRuleResponse": {
+ "properties": {
+ "rule": {
+ "description": "The rule that was deleted.",
+ "$ref": "ConditionalFormatRule"
+ }
+ },
+ "id": "DeleteConditionalFormatRuleResponse",
+ "description": "The result of deleting a conditional format rule.",
+ "type": "object"
+ },
+ "RandomizeRangeRequest": {
+ "properties": {
+ "range": {
+ "description": "The range to randomize.",
+ "$ref": "GridRange"
+ }
+ },
+ "id": "RandomizeRangeRequest",
+ "description": "Randomizes the order of the rows in a range.",
+ "type": "object"
+ },
+ "DeleteRangeRequest": {
+ "description": "Deletes a range of cells, shifting other cells into the deleted area.",
+ "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 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"
+ },
+ "GridCoordinate": {
+ "description": "A coordinate in a sheet.\nAll indexes are zero-based.",
+ "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"
+ },
+ "UpdateSheetPropertiesRequest": {
+ "properties": {
+ "properties": {
+ "$ref": "SheetProperties",
+ "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"
+ }
+ },
+ "id": "UpdateSheetPropertiesRequest",
+ "description": "Updates properties of the sheet with the specified\nsheetId.",
+ "type": "object"
+ },
+ "UnmergeCellsRequest": {
+ "properties": {
+ "range": {
+ "$ref": "GridRange",
+ "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."
+ }
+ },
+ "id": "UnmergeCellsRequest",
+ "description": "Unmerges cells in the given range.",
+ "type": "object"
+ },
+ "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"
+ },
+ "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"
+ },
+ "Sheet": {
+ "description": "A sheet in a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "charts": {
+ "description": "The specifications of every chart on this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "EmbeddedChart"
+ }
+ },
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties of the sheet."
+ },
+ "filterViews": {
+ "description": "The filter views in this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "FilterView"
+ }
+ },
+ "conditionalFormats": {
+ "description": "The conditional format rules in this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "ConditionalFormatRule"
+ }
+ },
+ "protectedRanges": {
+ "description": "The protected ranges in this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "ProtectedRange"
+ }
+ },
+ "developerMetadata": {
+ "description": "The developer metadata associated with a sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "id": "Sheet"
+ },
+ "SortSpec": {
+ "properties": {
+ "sortOrder": {
+ "enumDescriptions": [
+ "Default value, do not use this.",
+ "Sort ascending.",
+ "Sort descending."
+ ],
+ "enum": [
+ "SORT_ORDER_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "description": "The order data should be sorted.",
+ "type": "string"
+ },
+ "dimensionIndex": {
+ "description": "The dimension the sort should be applied to.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "SortSpec",
+ "description": "A sort order associated with a specific column or row.",
+ "type": "object"
+ },
+ "BooleanRule": {
+ "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",
+ "description": "A rule that may or may not match, depending on the condition.",
+ "type": "object"
+ },
+ "PivotGroupValueMetadata": {
+ "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",
+ "description": "Metadata about a value in a pivot grouping.",
+ "type": "object"
+ },
+ "FilterCriteria": {
+ "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",
+ "description": "Criteria for showing/hiding rows in a filter or filter view.",
+ "type": "object"
+ },
+ "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": {
+ "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"
+ },
+ "UpdateConditionalFormatRuleRequest": {
+ "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",
+ "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index.",
+ "type": "object"
+ },
+ "DataValidationRule": {
+ "description": "A data validation rule.",
+ "type": "object",
+ "properties": {
+ "condition": {
+ "description": "The condition that data in the cell must match.",
+ "$ref": "BooleanCondition"
+ },
+ "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"
+ }
+ },
+ "id": "DataValidationRule"
+ },
+ "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"
+ },
+ "PasteDataRequest": {
+ "properties": {
+ "html": {
+ "description": "True if the data is HTML.",
+ "type": "boolean"
+ },
+ "coordinate": {
+ "description": "The coordinate at which the data should start being inserted.",
+ "$ref": "GridCoordinate"
+ },
+ "data": {
+ "description": "The data to insert.",
+ "type": "string"
+ },
+ "delimiter": {
+ "description": "The delimiter in the data.",
+ "type": "string"
+ },
+ "type": {
+ "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.",
+ "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."
+ ]
+ }
+ },
+ "id": "PasteDataRequest",
+ "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
+ "type": "object"
+ },
+ "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": {
+ "properties": {
+ "developerMetadata": {
+ "description": "The developer metadata that was created.",
+ "$ref": "DeveloperMetadata"
+ }
+ },
+ "id": "CreateDeveloperMetadataResponse",
+ "description": "The response from creating developer metadata.",
+ "type": "object"
+ },
+ "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": {
+ "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",
+ "description": "The rotation applied to text in a cell.",
+ "type": "object"
+ },
+ "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": {
+ "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": {
+ "description": "The value that all metadata matched by the data filters will be updated to.",
+ "$ref": "DeveloperMetadata"
+ },
+ "dataFilters": {
+ "description": "The filters matching the developer metadata entries to update.",
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ }
+ }
+ },
+ "id": "UpdateDeveloperMetadataRequest"
+ },
+ "PieChartSpec": {
+ "description": "A \u003ca href=\"/chart/interactive/docs/gallery/piechart\"\u003epie chart\u003c/a\u003e.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "True if the pie is three dimensional.",
+ "type": "boolean"
+ },
+ "series": {
+ "description": "The data that covers the one and only series of the pie chart.",
+ "$ref": "ChartData"
+ }
+ },
+ "id": "PieChartSpec"
+ },
+ "UpdateFilterViewRequest": {
+ "description": "Updates properties of the filter view.",
+ "type": "object",
+ "properties": {
+ "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.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "filter": {
+ "$ref": "FilterView",
+ "description": "The new properties of the filter view."
+ }
+ },
+ "id": "UpdateFilterViewRequest"
+ },
+ "ConditionalFormatRule": {
+ "description": "A rule describing a conditional format.",
+ "type": "object",
+ "properties": {
+ "gradientRule": {
+ "$ref": "GradientRule",
+ "description": "The formatting will vary based on the gradients in the rule."
+ },
+ "booleanRule": {
+ "$ref": "BooleanRule",
+ "description": "The formatting is either \"on\" or \"off\" according to the rule."
+ },
+ "ranges": {
+ "description": "The ranges that will be formatted if the condition is true.\nAll the ranges must be on the same grid.",
+ "type": "array",
+ "items": {
+ "$ref": "GridRange"
+ }
+ }
+ },
+ "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": {
+ "description": "The source range to copy.",
+ "$ref": "GridRange"
+ },
+ "pasteType": {
+ "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": "What kind of data to paste.",
+ "type": "string"
+ }
+ },
+ "id": "CopyPasteRequest"
+ },
+ "BooleanCondition": {
+ "properties": {
+ "type": {
+ "enum": [
+ "CONDITION_TYPE_UNSPECIFIED",
+ "NUMBER_GREATER",
+ "NUMBER_GREATER_THAN_EQ",
+ "NUMBER_LESS",
+ "NUMBER_LESS_THAN_EQ",
+ "NUMBER_EQ",
+ "NUMBER_NOT_EQ",
+ "NUMBER_BETWEEN",
+ "NUMBER_NOT_BETWEEN",
+ "TEXT_CONTAINS",
+ "TEXT_NOT_CONTAINS",
+ "TEXT_STARTS_WITH",
+ "TEXT_ENDS_WITH",
+ "TEXT_EQ",
+ "TEXT_IS_EMAIL",
+ "TEXT_IS_URL",
+ "DATE_EQ",
+ "DATE_BEFORE",
+ "DATE_AFTER",
+ "DATE_ON_OR_BEFORE",
+ "DATE_ON_OR_AFTER",
+ "DATE_BETWEEN",
+ "DATE_NOT_BETWEEN",
+ "DATE_IS_VALID",
+ "ONE_OF_RANGE",
+ "ONE_OF_LIST",
+ "BLANK",
+ "NOT_BLANK",
+ "CUSTOM_FORMULA"
+ ],
+ "description": "The type of condition.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "The cell's value must be greater than the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be greater than or equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be less than the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be less than or equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be not equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
+ "The cell's value must not be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
+ "The cell's value must contain the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must not contain the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must start with the condition's value.\nSupported by conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must end with the condition's value.\nSupported by conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be exactly the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be a valid email address.\nSupported by data validation.\nRequires no ConditionValues.",
+ "The cell's value must be a valid URL.\nSupported by data validation.\nRequires no ConditionValues.",
+ "The cell's value must be the same date as the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
+ "The cell's value must be before the date of the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue\nthat may be a relative date.",
+ "The cell's value must be after the date of the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue\nthat may be a relative date.",
+ "The cell's value must be on or before the date of the condition's value.\nSupported by data validation.\nRequires a single ConditionValue\nthat may be a relative date.",
+ "The cell's value must be on or after the date of the condition's value.\nSupported by data validation.\nRequires a single ConditionValue\nthat may be a relative date.",
+ "The cell's value must be between the dates of the two condition values.\nSupported by data validation.\nRequires exactly two ConditionValues.",
+ "The cell's value must be outside the dates of the two condition values.\nSupported by data validation.\nRequires exactly two ConditionValues.",
+ "The cell's value must be a date.\nSupported by data validation.\nRequires no ConditionValues.",
+ "The cell's value must be listed in the grid in condition value's range.\nSupported by data validation.\nRequires a single ConditionValue,\nand the value must be a valid range in A1 notation.",
+ "The cell's value must in the list of condition values.\nSupported by data validation.\nSupports any number of condition values,\none per item in the list.\nFormulas are not supported in the values.",
+ "The cell's value must be empty.\nSupported by conditional formatting and filters.\nRequires no ConditionValues.",
+ "The cell's value must not be empty.\nSupported by conditional formatting and filters.\nRequires no ConditionValues.",
+ "The condition's formula must evaluate to true.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue."
+ ]
+ },
+ "values": {
+ "description": "The values of the condition. The number of supported values depends\non the condition type. Some support zero values,\nothers one or two values,\nand ConditionType.ONE_OF_LIST supports an arbitrary number of values.",
+ "type": "array",
+ "items": {
+ "$ref": "ConditionValue"
+ }
+ }
+ },
+ "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"
+ },
+ "Request": {
+ "properties": {
+ "deleteNamedRange": {
+ "$ref": "DeleteNamedRangeRequest",
+ "description": "Deletes a named range."
+ },
+ "addProtectedRange": {
+ "$ref": "AddProtectedRangeRequest",
+ "description": "Adds a protected range."
+ },
+ "duplicateSheet": {
+ "description": "Duplicates a sheet.",
+ "$ref": "DuplicateSheetRequest"
+ },
+ "deleteSheet": {
+ "description": "Deletes a sheet.",
+ "$ref": "DeleteSheetRequest"
+ },
+ "unmergeCells": {
+ "description": "Unmerges merged cells.",
+ "$ref": "UnmergeCellsRequest"
+ },
+ "updateEmbeddedObjectPosition": {
+ "description": "Updates an embedded object's (e.g. chart, image) position.",
+ "$ref": "UpdateEmbeddedObjectPositionRequest"
+ },
+ "updateDimensionProperties": {
+ "$ref": "UpdateDimensionPropertiesRequest",
+ "description": "Updates dimensions' properties."
+ },
+ "updateDeveloperMetadata": {
+ "$ref": "UpdateDeveloperMetadataRequest",
+ "description": "Updates an existing developer metadata entry"
+ },
+ "pasteData": {
+ "$ref": "PasteDataRequest",
+ "description": "Pastes data (HTML or delimited) into a sheet."
+ },
+ "setBasicFilter": {
+ "$ref": "SetBasicFilterRequest",
+ "description": "Sets the basic filter on a sheet."
+ },
+ "addConditionalFormatRule": {
+ "description": "Adds a new conditional format rule.",
+ "$ref": "AddConditionalFormatRuleRequest"
+ },
+ "addNamedRange": {
+ "description": "Adds a named range.",
+ "$ref": "AddNamedRangeRequest"
+ },
+ "updateCells": {
+ "$ref": "UpdateCellsRequest",
+ "description": "Updates many cells at once."
+ },
+ "updateSpreadsheetProperties": {
+ "$ref": "UpdateSpreadsheetPropertiesRequest",
+ "description": "Updates the spreadsheet's properties."
+ },
+ "deleteEmbeddedObject": {
+ "description": "Deletes an embedded object (e.g, chart, image) in a sheet.",
+ "$ref": "DeleteEmbeddedObjectRequest"
+ },
+ "updateFilterView": {
+ "$ref": "UpdateFilterViewRequest",
+ "description": "Updates the properties of a filter view."
+ },
+ "addBanding": {
+ "description": "Adds a new banded range",
+ "$ref": "AddBandingRequest"
+ },
+ "appendCells": {
+ "description": "Appends cells after the last row with data in a sheet.",
+ "$ref": "AppendCellsRequest"
+ },
+ "autoResizeDimensions": {
+ "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
+ "$ref": "AutoResizeDimensionsRequest"
+ },
+ "cutPaste": {
+ "$ref": "CutPasteRequest",
+ "description": "Cuts data from one area and pastes it to another."
+ },
+ "mergeCells": {
+ "description": "Merges cells together.",
+ "$ref": "MergeCellsRequest"
+ },
+ "updateNamedRange": {
+ "$ref": "UpdateNamedRangeRequest",
+ "description": "Updates a named range."
+ },
+ "updateSheetProperties": {
+ "$ref": "UpdateSheetPropertiesRequest",
+ "description": "Updates a sheet's properties."
+ },
+ "autoFill": {
+ "description": "Automatically fills in more data based on existing data.",
+ "$ref": "AutoFillRequest"
+ },
+ "deleteDimension": {
+ "$ref": "DeleteDimensionRequest",
+ "description": "Deletes rows or columns in a sheet."
+ },
+ "sortRange": {
+ "$ref": "SortRangeRequest",
+ "description": "Sorts data in a range."
+ },
+ "deleteProtectedRange": {
+ "description": "Deletes a protected range.",
+ "$ref": "DeleteProtectedRangeRequest"
+ },
+ "duplicateFilterView": {
+ "$ref": "DuplicateFilterViewRequest",
+ "description": "Duplicates a filter view."
+ },
+ "addChart": {
+ "description": "Adds a chart.",
+ "$ref": "AddChartRequest"
+ },
+ "findReplace": {
+ "$ref": "FindReplaceRequest",
+ "description": "Finds and replaces occurrences of some text with other text."
+ },
+ "updateChartSpec": {
+ "$ref": "UpdateChartSpecRequest",
+ "description": "Updates a chart's specifications."
+ },
+ "textToColumns": {
+ "description": "Converts a column of text into many columns of text.",
+ "$ref": "TextToColumnsRequest"
+ },
+ "addSheet": {
+ "$ref": "AddSheetRequest",
+ "description": "Adds a sheet."
+ },
+ "updateProtectedRange": {
+ "description": "Updates a protected range.",
+ "$ref": "UpdateProtectedRangeRequest"
+ },
+ "deleteFilterView": {
+ "description": "Deletes a filter view from a sheet.",
+ "$ref": "DeleteFilterViewRequest"
+ },
+ "copyPaste": {
+ "description": "Copies data from one area and pastes it to another.",
+ "$ref": "CopyPasteRequest"
+ },
+ "insertDimension": {
+ "$ref": "InsertDimensionRequest",
+ "description": "Inserts new rows or columns in a sheet."
+ },
+ "deleteRange": {
+ "description": "Deletes a range of cells from a sheet, shifting the remaining cells.",
+ "$ref": "DeleteRangeRequest"
+ },
+ "deleteBanding": {
+ "description": "Removes a banded range",
+ "$ref": "DeleteBandingRequest"
+ },
+ "addFilterView": {
+ "description": "Adds a filter view.",
+ "$ref": "AddFilterViewRequest"
+ },
+ "updateBorders": {
+ "$ref": "UpdateBordersRequest",
+ "description": "Updates the borders in a range of cells."
+ },
+ "setDataValidation": {
+ "$ref": "SetDataValidationRequest",
+ "description": "Sets data validation for one or more cells."
+ },
+ "deleteConditionalFormatRule": {
+ "$ref": "DeleteConditionalFormatRuleRequest",
+ "description": "Deletes an existing conditional format rule."
+ },
+ "clearBasicFilter": {
+ "description": "Clears the basic filter on a sheet.",
+ "$ref": "ClearBasicFilterRequest"
+ },
+ "repeatCell": {
+ "$ref": "RepeatCellRequest",
+ "description": "Repeats a single cell across a range."
+ },
+ "appendDimension": {
+ "description": "Appends dimensions to the end of a sheet.",
+ "$ref": "AppendDimensionRequest"
+ },
+ "createDeveloperMetadata": {
+ "$ref": "CreateDeveloperMetadataRequest",
+ "description": "Creates new developer metadata"
+ },
+ "updateConditionalFormatRule": {
+ "description": "Updates an existing conditional format rule.",
+ "$ref": "UpdateConditionalFormatRuleRequest"
+ },
+ "insertRange": {
+ "description": "Inserts new cells in a sheet, shifting the existing cells.",
+ "$ref": "InsertRangeRequest"
+ },
+ "deleteDeveloperMetadata": {
+ "description": "Deletes developer metadata",
+ "$ref": "DeleteDeveloperMetadataRequest"
+ },
+ "moveDimension": {
+ "$ref": "MoveDimensionRequest",
+ "description": "Moves rows or columns to another location in a sheet."
+ },
+ "randomizeRange": {
+ "description": "Randomizes the order of the rows in a range.",
+ "$ref": "RandomizeRangeRequest"
+ },
+ "updateBanding": {
+ "description": "Updates a banded range",
+ "$ref": "UpdateBandingRequest"
+ }
+ },
+ "id": "Request",
+ "description": "A single kind of update to apply to a spreadsheet.",
+ "type": "object"
+ },
+ "GridRange": {
+ "properties": {
+ "endRowIndex": {
+ "description": "The end row (exclusive) of the range, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "endColumnIndex": {
+ "description": "The end column (exclusive) of the range, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "startRowIndex": {
+ "description": "The start row (inclusive) of the range, or not set if unbounded.",
+ "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",
+ "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"
+ },
+ "BasicChartSpec": {
+ "properties": {
+ "domains": {
+ "description": "The domain of data this is charting.\nOnly a single domain is supported.",
+ "type": "array",
+ "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": {
+ "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",
+ "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."
+ ]
+ },
+ "threeDimensional": {
+ "description": "True to make the chart 3D.\nApplies to Bar and Column charts.",
+ "type": "boolean"
+ },
+ "axis": {
+ "description": "The axis on the chart.",
+ "type": "array",
+ "items": {
+ "$ref": "BasicChartAxis"
+ }
+ },
+ "chartType": {
+ "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",
+ "LINE",
+ "AREA",
+ "COLUMN",
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "BasicChartSeries"
+ }
+ },
+ "legendPosition": {
+ "enum": [
+ "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
+ "BOTTOM_LEGEND",
+ "LEFT_LEGEND",
+ "RIGHT_LEGEND",
+ "TOP_LEGEND",
+ "NO_LEGEND"
+ ],
+ "description": "The position of the chart legend.",
+ "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."
+ ]
+ },
+ "compareMode": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "Only the focused data element is highlighted and shown in the tooltip.",
+ "All data elements with the same category (e.g., domain value) are\nhighlighted and shown in the tooltip."
+ ],
+ "enum": [
+ "BASIC_CHART_COMPARE_MODE_UNSPECIFIED",
+ "DATUM",
+ "CATEGORY"
+ ],
+ "description": "The behavior of tooltips and data highlighting when hovering on data and\nchart area.",
+ "type": "string"
+ }
+ },
+ "id": "BasicChartSpec",
+ "description": "The specification for a basic chart. See BasicChartType for the list\nof charts this supports.",
+ "type": "object"
+ },
+ "SetDataValidationRequest": {
+ "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": "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"
+ },
+ "BubbleChartSpec": {
+ "properties": {
+ "domain": {
+ "description": "The data containing the bubble x-values. These values locate the bubbles\nin the chart horizontally.",
+ "$ref": "ChartData"
+ },
+ "bubbleSizes": {
+ "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.",
+ "$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"
+ },
+ "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": {
+ "$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"
+ },
+ "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": {
+ "$ref": "ChartData",
+ "description": "The data contianing the bubble y-values. These values locate the bubbles\nin the chart vertically."
+ },
+ "legendPosition": {
+ "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.",
+ "The legend is rendered inside the chart area."
+ ],
+ "enum": [
+ "BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED",
+ "BOTTOM_LEGEND",
+ "LEFT_LEGEND",
+ "RIGHT_LEGEND",
+ "TOP_LEGEND",
+ "NO_LEGEND",
+ "INSIDE_LEGEND"
+ ],
+ "description": "Where the legend of the chart should be drawn.",
+ "type": "string"
+ }
+ },
+ "id": "BubbleChartSpec",
+ "description": "A \u003ca href=\"/chart/interactive/docs/gallery/bubblechart\"\u003ebubble chart\u003c/a\u003e.",
+ "type": "object"
+ },
+ "CellData": {
+ "properties": {
+ "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",
+ "items": {
+ "$ref": "TextFormatRun"
+ }
+ },
+ "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"
+ },
+ "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."
+ },
+ "note": {
+ "description": "Any note on the cell.",
+ "type": "string"
+ },
+ "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": {
+ "$ref": "DataValidationRule",
+ "description": "A data validation rule on the cell, if any.\n\nWhen writing, the new data validation rule will overwrite any prior rule."
+ },
+ "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."
+ }
+ },
+ "id": "CellData",
+ "description": "Data about a specific cell.",
+ "type": "object"
+ },
+ "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\"`."
+ ],
+ "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": {
+ "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": {
+ "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"
+ },
+ "TextPosition": {
+ "properties": {
+ "horizontalAlignment": {
+ "enum": [
+ "HORIZONTAL_ALIGN_UNSPECIFIED",
+ "LEFT",
+ "CENTER",
+ "RIGHT"
+ ],
+ "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.",
+ "The text is explicitly aligned to the center of the cell.",
+ "The text is explicitly aligned to the right of the cell."
+ ]
+ }
+ },
+ "id": "TextPosition",
+ "description": "Position settings for text.",
+ "type": "object"
+ },
+ "BatchUpdateSpreadsheetRequest": {
+ "description": "The request for updating any aspect of a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "includeSpreadsheetInResponse": {
+ "description": "Determines if the update response should include the spreadsheet\nresource.",
+ "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"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "id": "BatchUpdateSpreadsheetRequest"
+ },
+ "Padding": {
+ "properties": {
+ "right": {
+ "description": "The right padding of the cell.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "bottom": {
+ "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",
+ "description": "The amount of padding around the cell, in pixels.\nWhen updating padding, every field must be specified.",
+ "type": "object"
+ },
+ "BasicChartAxis": {
+ "description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position.",
+ "type": "object",
+ "properties": {
+ "titleTextPosition": {
+ "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"
+ },
+ "position": {
+ "enum": [
+ "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
+ "BOTTOM_AXIS",
+ "LEFT_AXIS",
+ "RIGHT_AXIS"
+ ],
+ "description": "The position of this axis.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
+ "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
+ "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
+ ]
+ },
+ "title": {
+ "description": "The title of this axis. If set, this overrides any title inferred\nfrom headers of the data.",
+ "type": "string"
+ }
+ },
+ "id": "BasicChartAxis"
+ },
+ "DeleteDimensionRequest": {
+ "properties": {
+ "range": {
+ "description": "The dimensions to delete from the sheet.",
+ "$ref": "DimensionRange"
+ }
+ },
+ "id": "DeleteDimensionRequest",
+ "description": "Deletes the dimensions from the sheet.",
+ "type": "object"
+ },
+ "UpdateChartSpecRequest": {
+ "properties": {
+ "spec": {
+ "description": "The specification to apply to the chart.",
+ "$ref": "ChartSpec"
+ },
+ "chartId": {
+ "description": "The ID of the chart to update.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "UpdateChartSpecRequest",
+ "description": "Updates a chart's specifications.\n(This does not move or resize a chart. To move or resize a chart, use\n UpdateEmbeddedObjectPositionRequest.)",
+ "type": "object"
+ },
+ "DeleteFilterViewRequest": {
+ "properties": {
+ "filterId": {
+ "description": "The ID of the filter to delete.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteFilterViewRequest",
+ "description": "Deletes a particular filter view.",
+ "type": "object"
+ },
+ "DeleteDeveloperMetadataResponse": {
+ "description": "The response from deleting developer metadata.",
+ "type": "object",
+ "properties": {
+ "deletedDeveloperMetadata": {
+ "description": "The metadata that was deleted.",
+ "type": "array",
+ "items": {
+ "$ref": "DeveloperMetadata"
+ }
+ }
+ },
+ "id": "DeleteDeveloperMetadataResponse"
+ },
+ "BatchGetValuesByDataFilterRequest": {
+ "properties": {
+ "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",
+ "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\"`."
+ ]
+ },
+ "dateTimeRenderOption": {
+ "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",
+ "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)."
+ ]
+ },
+ "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 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",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ]
+ },
+ "dataFilters": {
+ "description": "The data filters used to match the ranges of values to retrieve. Ranges\nthat match any of the specified data filters will be included in the\nresponse.",
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ }
+ }
+ },
+ "id": "BatchGetValuesByDataFilterRequest",
+ "description": "The request for retrieving a range of values in a spreadsheet selected by a\nset of DataFilters.",
+ "type": "object"
+ },
+ "BatchUpdateValuesResponse": {
+ "properties": {
+ "responses": {
+ "description": "One UpdateValuesResponse per requested range, in the same order as\nthe requests appeared.",
+ "type": "array",
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "BatchUpdateValuesResponse",
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object"
+ },
+ "SortRangeRequest": {
+ "description": "Sorts data in rows based on a sort order per column.",
+ "type": "object",
+ "properties": {
+ "sortSpecs": {
+ "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
+ "type": "array",
+ "items": {
+ "$ref": "SortSpec"
+ }
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to sort."
+ }
+ },
+ "id": "SortRangeRequest"
+ },
+ "MatchedDeveloperMetadata": {
+ "description": "A developer metadata entry and the data filters specified in the original\nrequest that matched it.",
+ "type": "object",
+ "properties": {
+ "developerMetadata": {
+ "$ref": "DeveloperMetadata",
+ "description": "The developer metadata matching the specified filters."
+ },
+ "dataFilters": {
+ "description": "All filters matching the returned developer metadata.",
+ "type": "array",
+ "items": {
+ "$ref": "DataFilter"
+ }
+ }
+ },
+ "id": "MatchedDeveloperMetadata"
+ },
+ "MergeCellsRequest": {
+ "properties": {
+ "range": {
+ "description": "The range of cells to merge.",
+ "$ref": "GridRange"
+ },
+ "mergeType": {
+ "enum": [
+ "MERGE_ALL",
+ "MERGE_COLUMNS",
+ "MERGE_ROWS"
+ ],
+ "description": "How the cells should be merged.",
+ "type": "string",
+ "enumDescriptions": [
+ "Create a single merge from the range",
+ "Create a merge for each column in the range",
+ "Create a merge for each row in the range"
+ ]
+ }
+ },
+ "id": "MergeCellsRequest",
+ "description": "Merges all cells in the range.",
+ "type": "object"
+ },
+ "AddProtectedRangeRequest": {
+ "description": "Adds a new protected range.",
+ "type": "object",
+ "properties": {
+ "protectedRange": {
+ "$ref": "ProtectedRange",
+ "description": "The protected range to be added. The\nprotectedRangeId field is optional; if\none is not set, an id will be randomly generated. (It is an error to\nspecify the ID of a range that already exists.)"
+ }
+ },
+ "id": "AddProtectedRangeRequest"
+ },
+ "BatchClearValuesRequest": {
+ "properties": {
+ "ranges": {
+ "description": "The ranges to clear, in A1 notation.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "BatchClearValuesRequest",
+ "description": "The request for clearing more than one range of values in a spreadsheet.",
+ "type": "object"
+ },
+ "DeveloperMetadata": {
+ "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"
+ },
+ "metadataId": {
+ "description": "The spreadsheet-scoped unique ID that identifies the metadata. IDs may be\nspecified when metadata is created, otherwise one will be randomly\ngenerated and assigned. Must be positive.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "location": {
+ "$ref": "DeveloperMetadataLocation",
+ "description": "The location where the metadata is associated."
+ },
+ "visibility": {
+ "enum": [
+ "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED",
+ "DOCUMENT",
+ "PROJECT"
+ ],
+ "description": "The metadata visibility. Developer metadata must always have a visibility\nspecified.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value.",
+ "Document-visible metadata is accessible from any developer project with\naccess to the document.",
+ "Project-visible metadata is only visible to and accessible by the developer\nproject that created the metadata."
+ ]
+ }
+ },
+ "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"
+ },
+ "DuplicateFilterViewResponse": {
+ "description": "The result of a filter view being duplicated.",
+ "type": "object",
+ "properties": {
+ "filter": {
+ "description": "The newly created filter.",
+ "$ref": "FilterView"
+ }
+ },
+ "id": "DuplicateFilterViewResponse"
+ },
+ "DuplicateSheetResponse": {
+ "properties": {
+ "properties": {
+ "$ref": "SheetProperties",
+ "description": "The properties of the duplicate sheet."
+ }
+ },
+ "id": "DuplicateSheetResponse",
+ "description": "The result of duplicating a sheet.",
+ "type": "object"
+ },
+ "ClearBasicFilterRequest": {
+ "properties": {
+ "sheetId": {
+ "description": "The sheet ID on which the basic filter should be cleared.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ClearBasicFilterRequest",
+ "description": "Clears the basic filter, if any exists on the sheet.",
+ "type": "object"
+ },
+ "TextToColumnsRequest": {
+ "properties": {
+ "delimiter": {
+ "description": "The delimiter to use. Used only if delimiterType is\nCUSTOM.",
+ "type": "string"
+ },
+ "source": {
+ "description": "The source data range. This must span exactly one column.",
+ "$ref": "GridRange"
+ },
+ "delimiterType": {
+ "enumDescriptions": [
+ "Default value. This value must not be used.",
+ "\",\"",
+ "\";\"",
+ "\".\"",
+ "\" \"",
+ "A custom value as defined in delimiter."
+ ],
+ "enum": [
+ "DELIMITER_TYPE_UNSPECIFIED",
+ "COMMA",
+ "SEMICOLON",
+ "PERIOD",
+ "SPACE",
+ "CUSTOM"
+ ],
+ "description": "The delimiter type to use.",
+ "type": "string"
+ }
+ },
+ "id": "TextToColumnsRequest",
+ "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell.",
+ "type": "object"
+ },
+ "DeleteBandingRequest": {
+ "properties": {
+ "bandedRangeId": {
+ "description": "The ID of the banded range to delete.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteBandingRequest",
+ "description": "Removes the banded range with the given ID from the spreadsheet.",
+ "type": "object"
+ },
+ "BatchUpdateSpreadsheetResponse": {
+ "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"
+ }
+ },
+ "updatedSpreadsheet": {
+ "$ref": "Spreadsheet",
+ "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`."
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ }
+ },
+ "id": "BatchUpdateSpreadsheetResponse",
+ "description": "The reply for batch updating a spreadsheet.",
+ "type": "object"
+ },
+ "AppendValuesResponse": {
+ "properties": {
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "updates": {
+ "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"
+ },
+ "PivotFilterCriteria": {
+ "properties": {
+ "visibleValues": {
+ "description": "Values that should be included. Values not listed here are excluded.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "PivotFilterCriteria",
+ "description": "Criteria for showing/hiding rows in a pivot table.",
+ "type": "object"
+ },
+ "AddFilterViewRequest": {
+ "properties": {
+ "filter": {
+ "description": "The filter to add. The filterViewId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a filter that already exists.)",
+ "$ref": "FilterView"
+ }
+ },
+ "id": "AddFilterViewRequest",
+ "description": "Adds a filter view.",
+ "type": "object"
+ },
+ "MoveDimensionRequest": {
+ "description": "Moves one or more rows or columns.",
+ "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."
+ }
+ },
+ "id": "MoveDimensionRequest"
+ },
+ "AddConditionalFormatRuleRequest": {
+ "description": "Adds a new conditional format rule at the given index.\nAll subsequent rules' indexes are incremented.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "ChartSpec": {
+ "properties": {
+ "altText": {
+ "description": "The alternative text that describes the chart. This is often used\nfor accessibility.",
+ "type": "string"
+ },
+ "titleTextPosition": {
+ "description": "The title text position.\nThis field is optional.",
+ "$ref": "TextPosition"
+ },
+ "histogramChart": {
+ "$ref": "HistogramChartSpec",
+ "description": "A histogram chart specification."
+ },
+ "candlestickChart": {
+ "$ref": "CandlestickChartSpec",
+ "description": "A candlestick chart specification."
+ },
+ "bubbleChart": {
+ "description": "A bubble chart specification.",
+ "$ref": "BubbleChartSpec"
+ },
+ "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"
+ },
+ "hiddenDimensionStrategy": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "Charts will skip hidden rows and columns.",
+ "Charts will skip hidden rows only.",
+ "Charts will skip hidden columns only.",
+ "Charts will not skip any hidden rows or columns."
+ ],
+ "enum": [
+ "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED",
+ "SKIP_HIDDEN_ROWS_AND_COLUMNS",
+ "SKIP_HIDDEN_ROWS",
+ "SKIP_HIDDEN_COLUMNS",
+ "SHOW_ALL"
+ ],
+ "description": "Determines how the charts will use hidden rows or columns.",
+ "type": "string"
+ },
+ "subtitleTextFormat": {
+ "description": "The subtitle text format.\nStrikethrough and underline are not supported.",
+ "$ref": "TextFormat"
+ },
+ "subtitle": {
+ "description": "The subtitle of the chart.",
+ "type": "string"
+ },
+ "backgroundColor": {
+ "$ref": "Color",
+ "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."
+ },
+ "basicChart": {
+ "description": "A basic chart specification, can be one of many kinds of charts.\nSee BasicChartType for the list of all\ncharts this supports.",
+ "$ref": "BasicChartSpec"
+ },
+ "orgChart": {
+ "$ref": "OrgChartSpec",
+ "description": "An org chart specification."
+ },
+ "pieChart": {
+ "description": "A pie chart specification.",
+ "$ref": "PieChartSpec"
+ },
+ "titleTextFormat": {
+ "$ref": "TextFormat",
+ "description": "The title text format.\nStrikethrough and underline are not supported."
+ },
+ "title": {
+ "description": "The title of the chart.",
+ "type": "string"
+ }
+ },
+ "id": "ChartSpec",
+ "description": "The specifications of a chart.",
+ "type": "object"
+ },
+ "CreateDeveloperMetadataRequest": {
+ "properties": {
+ "developerMetadata": {
+ "description": "The developer metadata to create.",
+ "$ref": "DeveloperMetadata"
+ }
+ },
+ "id": "CreateDeveloperMetadataRequest",
+ "description": "A request to create developer metadata.",
+ "type": "object"
+ },
+ "BatchGetValuesByDataFilterResponse": {
+ "properties": {
+ "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",
+ "description": "The response when retrieving more than one range of values in a spreadsheet\nselected by DataFilters.",
+ "type": "object"
+ },
+ "DataFilterValueRange": {
+ "properties": {
+ "dataFilter": {
+ "$ref": "DataFilter",
+ "description": "The data filter describing the location of the values in the spreadsheet."
+ },
+ "majorDimension": {
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The major dimension of the values.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ]
+ },
+ "values": {
+ "description": "The data to be written. If the provided values exceed any of the ranges\nmatched by the data filter then the request will fail. If the provided\nvalues are less than the matched ranges only the specified values will be\nwritten, existing values in the matched ranges will remain unaffected.",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ }
+ },
+ "id": "DataFilterValueRange",
+ "description": "A range of values whose location is specified by a DataFilter.",
+ "type": "object"
+ },
+ "NumberFormat": {
+ "description": "The number format of a cell.",
+ "type": "object",
+ "properties": {
+ "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`"
+ ],
+ "enum": [
+ "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"
+ },
+ "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": "NumberFormat"
+ },
+ "CandlestickDomain": {
+ "description": "The domain of a CandlestickChart.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "$ref": "ChartData",
+ "description": "The data of the CandlestickDomain."
+ },
+ "reversed": {
+ "description": "True to reverse the order of the domain values (horizontal axis).",
+ "type": "boolean"
+ }
+ },
+ "id": "CandlestickDomain"
+ },
+ "SheetProperties": {
+ "description": "Properties of a sheet.",
+ "type": "object",
+ "properties": {
+ "title": {
+ "description": "The name of the sheet.",
+ "type": "string"
+ },
+ "tabColor": {
+ "description": "The color of the tab in the UI.",
+ "$ref": "Color"
+ },
+ "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.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The ID of the sheet. Must be non-negative.\nThis field cannot be changed once set.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rightToLeft": {
+ "description": "True if the sheet is an RTL sheet instead of an LTR sheet.",
+ "type": "boolean"
+ },
+ "hidden": {
+ "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": {
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The sheet is a grid.",
+ "The sheet has no grid and instead has an object like a chart or image."
+ ],
+ "enum": [
+ "SHEET_TYPE_UNSPECIFIED",
+ "GRID",
+ "OBJECT"
+ ],
+ "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set.",
+ "type": "string"
+ }
+ },
+ "id": "SheetProperties"
+ },
+ "UpdateDimensionPropertiesRequest": {
+ "description": "Updates properties of dimensions within the specified range.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "description": "Properties to update.",
+ "$ref": "DimensionProperties"
+ },
+ "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.",
+ "type": "object",
+ "properties": {
+ "fillLength": {
+ "description": "The number of rows or columns that data should be filled into.\nPositive numbers expand beyond the last row or last column\nof the source. Negative numbers expand before the first row\nor first column of the source.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "source": {
+ "$ref": "GridRange",
+ "description": "The location of the data to use as the source of the autofill."
+ },
+ "dimension": {
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The dimension that data should be filled into.",
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ]
+ }
+ },
+ "id": "SourceAndDestination"
+ },
+ "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": {
+ "selectedNodeColor": {
+ "description": "The color of the selected org chart nodes.",
+ "$ref": "Color"
+ },
+ "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": {
+ "enum": [
+ "ORG_CHART_LABEL_SIZE_UNSPECIFIED",
+ "SMALL",
+ "MEDIUM",
+ "LARGE"
+ ],
+ "description": "The size of the org chart nodes.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The small org chart node size.",
+ "The medium org chart node size.",
+ "The large org chart node size."
+ ]
+ },
+ "labels": {
+ "description": "The data containing the labels for all the nodes in the chart. Labels\nmust be unique.",
+ "$ref": "ChartData"
+ },
+ "nodeColor": {
+ "$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."
+ }
+ },
+ "id": "OrgChartSpec"
+ },
+ "FilterView": {
+ "properties": {
"sortSpecs": {
"description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
"type": "array",
@@ -828,51 +3773,26 @@
"description": "The ID of the filter view.",
"format": "int32",
"type": "integer"
- }
- }
- },
- "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": {
- "selectedNodeColor": {
- "$ref": "Color",
- "description": "The color of the selected org chart nodes."
},
- "parentLabels": {
- "$ref": "ChartData",
- "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."
+ "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"
},
- "labels": {
- "description": "The data containing the labels for all the nodes in the chart. Labels\nmust be unique.",
- "$ref": "ChartData"
- },
- "nodeSize": {
- "enumDescriptions": [
- "Default value, do not use.",
- "The small org chart node size.",
- "The medium org chart node size.",
- "The large org chart node size."
- ],
- "enum": [
- "ORG_CHART_LABEL_SIZE_UNSPECIFIED",
- "SMALL",
- "MEDIUM",
- "LARGE"
- ],
- "description": "The size of the org chart nodes.",
+ "title": {
+ "description": "The name of the filter view.",
"type": "string"
},
- "nodeColor": {
- "description": "The color of the org chart nodes.",
- "$ref": "Color"
- },
- "tooltips": {
- "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"
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set."
}
},
- "id": "OrgChartSpec"
+ "id": "FilterView",
+ "description": "A filter view.",
+ "type": "object"
},
"SearchDeveloperMetadataRequest": {
"description": "A request to retrieve all developer metadata matching the set of specified\ncriteria.",
@@ -889,38 +3809,38 @@
"id": "SearchDeveloperMetadataRequest"
},
"BandingProperties": {
- "description": "Properties referring a single dimension (either row or column). If both\nBandedRange.row_properties and BandedRange.column_properties are\nset, the fill colors are applied to cells according to the following rules:\n\n* header_color and footer_color take priority over band colors.\n* first_band_color takes priority over second_band_color.\n* row_properties takes priority over column_properties.\n\nFor example, the first row color takes priority over the first column\ncolor, but the first column color takes priority over the second row color.\nSimilarly, the row header takes priority over the column header in the\ntop left cell, but the column header takes priority over the first row\ncolor if the row header is not set.",
- "type": "object",
"properties": {
+ "secondBandColor": {
+ "description": "The second color that is alternating. (Required)",
+ "$ref": "Color"
+ },
"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."
},
"headerColor": {
- "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"
+ "$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."
},
"firstBandColor": {
"$ref": "Color",
"description": "The first color that is alternating. (Required)"
- },
- "secondBandColor": {
- "description": "The second color that is alternating. (Required)",
- "$ref": "Color"
}
},
- "id": "BandingProperties"
+ "id": "BandingProperties",
+ "description": "Properties referring a single dimension (either row or column). If both\nBandedRange.row_properties and BandedRange.column_properties are\nset, the fill colors are applied to cells according to the following rules:\n\n* header_color and footer_color take priority over band colors.\n* first_band_color takes priority over second_band_color.\n* row_properties takes priority over column_properties.\n\nFor example, the first row color takes priority over the first column\ncolor, but the first column color takes priority over the second row color.\nSimilarly, the row header takes priority over the column header in the\ntop left cell, but the column header takes priority over the first row\ncolor if the row header is not set.",
+ "type": "object"
},
- "AddProtectedRangeResponse": {
- "type": "object",
+ "CandlestickSeries": {
"properties": {
- "protectedRange": {
- "description": "The newly added protected range.",
- "$ref": "ProtectedRange"
+ "data": {
+ "description": "The data of the CandlestickSeries.",
+ "$ref": "ChartData"
}
},
- "id": "AddProtectedRangeResponse",
- "description": "The result of adding a new protected range."
+ "id": "CandlestickSeries",
+ "description": "The series of a CandlestickData.",
+ "type": "object"
},
"BasicFilter": {
"description": "The default filter associated with a sheet.",
@@ -947,22 +3867,38 @@
},
"id": "BasicFilter"
},
- "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": {
+ "description": "The newly added protected range.",
+ "$ref": "ProtectedRange"
}
},
- "id": "CandlestickSeries"
+ "id": "AddProtectedRangeResponse"
},
"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": {
+ "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",
+ "type": "number"
+ },
+ "showItemDividers": {
+ "description": "Whether horizontal divider lines should be displayed between items in each\ncolumn.",
+ "type": "boolean"
+ },
+ "series": {
+ "description": "The series for a histogram may be either a single series of values to be\nbucketed or multiple series, each of the same length, containing the name\nof the series followed by the values to be bucketed for that series.",
+ "type": "array",
+ "items": {
+ "$ref": "HistogramSeries"
+ }
+ },
"legendPosition": {
- "type": "string",
"enumDescriptions": [
"Default value, do not use.",
"The legend is rendered on the bottom of the chart.",
@@ -981,37 +3917,25 @@
"NO_LEGEND",
"INSIDE_LEGEND"
],
- "description": "The position of the chart legend."
+ "description": "The position of the chart legend.",
+ "type": "string"
},
"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": {
- "type": "number",
- "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"
- },
- "showItemDividers": {
- "description": "Whether horizontal divider lines should be displayed between items in each\ncolumn.",
- "type": "boolean"
- },
- "series": {
- "description": "The series for a histogram may be either a single series of values to be\nbucketed or multiple series, each of the same length, containing the name\nof the series followed by the values to be bucketed for that series.",
- "type": "array",
- "items": {
- "$ref": "HistogramSeries"
- }
}
},
- "id": "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."
+ "id": "HistogramChartSpec"
},
"UpdateValuesResponse": {
"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"
+ },
"updatedRange": {
"description": "The range (in A1 notation) that updates were applied to.",
"type": "string"
@@ -1022,8 +3946,8 @@
"type": "integer"
},
"updatedData": {
- "description": "The values of the cells after updates were applied.\nThis is only included if the request's `includeValuesInResponse` field\nwas `true`.",
- "$ref": "ValueRange"
+ "$ref": "ValueRange",
+ "description": "The values of the cells after updates were applied.\nThis is only included if the request's `includeValuesInResponse` field\nwas `true`."
},
"updatedRows": {
"description": "The number of rows where at least one cell in the row was updated.",
@@ -1034,10 +3958,6 @@
"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"
}
},
"id": "UpdateValuesResponse"
@@ -1101,9 +4021,11 @@
"id": "PivotValue"
},
"ErrorValue": {
- "description": "An error in a cell.",
- "type": "object",
"properties": {
+ "message": {
+ "description": "A message with more information about the error\n(in the spreadsheet's locale).",
+ "type": "string"
+ },
"type": {
"enum": [
"ERROR_TYPE_UNSPECIFIED",
@@ -1131,27 +4053,24 @@
"Corresponds to the `#N/A` error.",
"Corresponds to the `Loading...` state."
]
- },
- "message": {
- "description": "A message with more information about the error\n(in the spreadsheet's locale).",
- "type": "string"
}
},
- "id": "ErrorValue"
+ "id": "ErrorValue",
+ "description": "An error in a cell.",
+ "type": "object"
},
"CopySheetToAnotherSpreadsheetRequest": {
- "id": "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",
+ "description": "The request to copy a sheet across spreadsheets.",
+ "type": "object"
},
"PivotGroupSortValueBucket": {
- "id": "PivotGroupSortValueBucket",
"description": "Information about which values in a pivot group should be used for sorting.",
"type": "object",
"properties": {
@@ -1167,13 +4086,14 @@
"$ref": "ExtendedValue"
}
}
- }
+ },
+ "id": "PivotGroupSortValueBucket"
},
"DeleteDeveloperMetadataRequest": {
"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",
@@ -1181,6 +4101,8 @@
"type": "object"
},
"CandlestickChartSpec": {
+ "description": "A \u003ca href=\"/chart/interactive/docs/gallery/candlestickchart\"\u003ecandlestick chart\u003c/a\u003e.",
+ "type": "object",
"properties": {
"domain": {
"description": "The domain data (horizontal axis) for the candlestick chart. String data\nwill be treated as discrete labels, other data will be treated as\ncontinuous values.",
@@ -1194,9 +4116,7 @@
}
}
},
- "id": "CandlestickChartSpec",
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/candlestickchart\"\u003ecandlestick chart\u003c/a\u003e.",
- "type": "object"
+ "id": "CandlestickChartSpec"
},
"BatchClearValuesByDataFilterResponse": {
"description": "The response when clearing a range of values selected with\nDataFilters in a spreadsheet.",
@@ -1217,27 +4137,27 @@
"id": "BatchClearValuesByDataFilterResponse"
},
"CandlestickData": {
- "id": "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"
+ "$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."
},
"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."
},
"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."
+ "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.",
+ "$ref": "CandlestickSeries"
+ },
+ "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"
}
- }
+ },
+ "id": "CandlestickData",
+ "description": "The Candlestick chart data, each containing the low, open, close, and high\nvalues for a series.",
+ "type": "object"
},
"EmbeddedObjectPosition": {
"properties": {
@@ -1260,8 +4180,6 @@
"type": "object"
},
"DeleteProtectedRangeRequest": {
- "description": "Deletes the protected range with the given ID.",
- "type": "object",
"properties": {
"protectedRangeId": {
"description": "The ID of the protected range to delete.",
@@ -1269,7 +4187,9 @@
"type": "integer"
}
},
- "id": "DeleteProtectedRangeRequest"
+ "id": "DeleteProtectedRangeRequest",
+ "description": "Deletes the protected range with the given ID.",
+ "type": "object"
},
"DeveloperMetadataLookup": {
"description": "Selects DeveloperMetadata that matches all of the specified fields. For\nexample, if only a metadata ID is specified this considers the\nDeveloperMetadata with that particular unique ID. If a metadata key is\nspecified, this considers all developer metadata with that key. If a\nkey, visibility, and location type are all specified, this considers all\ndeveloper metadata with that key and visibility that are associated with a\nlocation of that type. In general, this\nselects all DeveloperMetadata that matches the intersection of all the\nspecified fields; any field or combination of fields may be specified.",
@@ -1280,22 +4200,20 @@
"$ref": "DeveloperMetadataLocation"
},
"locationMatchingStrategy": {
+ "enum": [
+ "DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED",
+ "EXACT_LOCATION",
+ "INTERSECTING_LOCATION"
+ ],
"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",
"enumDescriptions": [
"Default value. This value must not be used.",
"Indicates that a specified location should be matched exactly. For\nexample, if row three were specified as a location this matching strategy\nwould only match developer metadata also associated on row three. Metadata\nassociated on other locations would not be considered.",
"Indicates that a specified location should match that exact location as\nwell as any intersecting locations. For example, if row three were\nspecified as a location this matching strategy would match developer\nmetadata associated on row three as well as metadata associated on\nlocations that intersect row three. If, for instance, there was developer\nmetadata associated on column B, this matching strategy would also match\nthat location because column B intersects row three."
- ],
- "enum": [
- "DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED",
- "EXACT_LOCATION",
- "INTERSECTING_LOCATION"
]
},
"locationType": {
- "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",
"enumDescriptions": [
"Default value.",
"Developer metadata associated on an entire row dimension.",
@@ -1309,11 +4227,13 @@
"COLUMN",
"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.",
+ "type": "string"
},
"metadataKey": {
- "type": "string",
- "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_key."
+ "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.",
@@ -1321,18 +4241,18 @@
"type": "integer"
},
"visibility": {
- "enumDescriptions": [
- "Default value.",
- "Document-visible metadata is accessible from any developer project with\naccess to the document.",
- "Project-visible metadata is only visible to and accessible by the developer\nproject that created the metadata."
- ],
"enum": [
"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"
+ "type": "string",
+ "enumDescriptions": [
+ "Default value.",
+ "Document-visible metadata is accessible from any developer project with\naccess to the document.",
+ "Project-visible metadata is only visible to and accessible by the developer\nproject that created the metadata."
+ ]
},
"metadataValue": {
"description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_value.",
@@ -1342,42 +4262,42 @@
"id": "DeveloperMetadataLookup"
},
"AutoFillRequest": {
- "id": "AutoFillRequest",
- "description": "Fills in more data based on existing data.",
- "type": "object",
"properties": {
"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"
},
"range": {
- "$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."
+ "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"
},
"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"
}
- }
+ },
+ "id": "AutoFillRequest",
+ "description": "Fills in more data based on existing data.",
+ "type": "object"
},
"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",
"properties": {
"minpoint": {
"description": "The starting interpolation point.",
"$ref": "InterpolationPoint"
},
"maxpoint": {
- "description": "The final interpolation point.",
- "$ref": "InterpolationPoint"
+ "$ref": "InterpolationPoint",
+ "description": "The final interpolation point."
},
"midpoint": {
"description": "An optional midway interpolation point.",
"$ref": "InterpolationPoint"
}
},
- "id": "GradientRule"
+ "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.",
@@ -1386,7 +4306,6 @@
"id": "ClearValuesRequest"
},
"SetBasicFilterRequest": {
- "type": "object",
"properties": {
"filter": {
"description": "The filter to set.",
@@ -1394,14 +4313,18 @@
}
},
"id": "SetBasicFilterRequest",
- "description": "Sets the basic filter associated with a sheet."
+ "description": "Sets the basic filter associated with a sheet.",
+ "type": "object"
},
"InterpolationPoint": {
- "type": "object",
"properties": {
+ "value": {
+ "description": "The value this interpolation point uses. May be a formula.\nUnused if type is MIN or\nMAX.",
+ "type": "string"
+ },
"color": {
- "$ref": "Color",
- "description": "The color this interpolation point should use."
+ "description": "The color this interpolation point should use.",
+ "$ref": "Color"
},
"type": {
"enumDescriptions": [
@@ -1422,16 +4345,14 @@
],
"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"
}
},
"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."
+ "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"
},
"BatchClearValuesByDataFilterRequest": {
+ "description": "The request for clearing more than one range selected by a\nDataFilter in a spreadsheet.",
"type": "object",
"properties": {
"dataFilters": {
@@ -1442,26 +4363,25 @@
}
}
},
- "id": "BatchClearValuesByDataFilterRequest",
- "description": "The request for clearing more than one range selected by a\nDataFilter in a spreadsheet."
+ "id": "BatchClearValuesByDataFilterRequest"
},
"GetSpreadsheetByDataFilterRequest": {
- "description": "The request for retrieving a Spreadsheet.",
- "type": "object",
"properties": {
+ "includeGridData": {
+ "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
+ "type": "boolean"
+ },
"dataFilters": {
"description": "The DataFilters used to select which ranges to retrieve from\nthe spreadsheet.",
"type": "array",
"items": {
"$ref": "DataFilter"
}
- },
- "includeGridData": {
- "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
- "type": "boolean"
}
},
- "id": "GetSpreadsheetByDataFilterRequest"
+ "id": "GetSpreadsheetByDataFilterRequest",
+ "description": "The request for retrieving a Spreadsheet.",
+ "type": "object"
},
"DeleteEmbeddedObjectRequest": {
"description": "Deletes the embedded object with the given ID.",
@@ -1476,13 +4396,7 @@
"id": "DeleteEmbeddedObjectRequest"
},
"FindReplaceResponse": {
- "type": "object",
"properties": {
- "formulasChanged": {
- "description": "The number of formula cells changed.",
- "format": "int32",
- "type": "integer"
- },
"valuesChanged": {
"description": "The number of non-formula cells changed.",
"format": "int32",
@@ -1494,18 +4408,24 @@
"type": "integer"
},
"rowsChanged": {
- "type": "integer",
"description": "The number of rows changed.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"sheetsChanged": {
"description": "The number of sheets changed.",
"format": "int32",
"type": "integer"
+ },
+ "formulasChanged": {
+ "description": "The number of formula cells changed.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "FindReplaceResponse",
- "description": "The result of the find/replace."
+ "description": "The result of the find/replace.",
+ "type": "object"
},
"UpdateValuesByDataFilterResponse": {
"description": "The response when updating a range of values by a data filter in a\nspreadsheet.",
@@ -1517,8 +4437,8 @@
"type": "integer"
},
"updatedRange": {
- "type": "string",
- "description": "The range (in A1 notation) that updates were applied to."
+ "description": "The range (in A1 notation) that updates were applied to.",
+ "type": "string"
},
"updatedCells": {
"description": "The number of cells updated.",
@@ -1526,8 +4446,8 @@
"type": "integer"
},
"dataFilter": {
- "description": "The data filter that selected the range that was updated.",
- "$ref": "DataFilter"
+ "$ref": "DataFilter",
+ "description": "The data filter that selected the range that was updated."
},
"updatedData": {
"$ref": "ValueRange",
@@ -1554,42 +4474,53 @@
"id": "DeleteSheetRequest"
},
"DuplicateFilterViewRequest": {
- "id": "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",
+ "description": "Duplicates a particular filter view.",
+ "type": "object"
},
"MatchedValueRange": {
"description": "A value range that was matched by one or more data filers.",
"type": "object",
"properties": {
+ "valueRange": {
+ "description": "The values matched by the DataFilter.",
+ "$ref": "ValueRange"
+ },
"dataFilters": {
"description": "The DataFilters from the request that matched the range of\nvalues.",
"type": "array",
"items": {
"$ref": "DataFilter"
}
- },
- "valueRange": {
- "$ref": "ValueRange",
- "description": "The values matched by the DataFilter."
}
},
"id": "MatchedValueRange"
},
"DeveloperMetadataLocation": {
- "id": "DeveloperMetadataLocation",
"description": "A location where metadata may be associated in a spreadsheet.",
"type": "object",
"properties": {
+ "dimensionRange": {
+ "$ref": "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."
+ },
+ "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"
+ },
"locationType": {
- "type": "string",
"enumDescriptions": [
"Default value.",
"Developer metadata associated on an entire row dimension.",
@@ -1604,53 +4535,49 @@
"SHEET",
"SPREADSHEET"
],
- "description": "The type of location this object represents. This field is read-only."
- },
- "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"
+ "description": "The type of location this object represents. This field is read-only.",
+ "type": "string"
}
- }
+ },
+ "id": "DeveloperMetadataLocation"
},
"UpdateConditionalFormatRuleResponse": {
+ "description": "The result of updating a conditional format rule.",
+ "type": "object",
"properties": {
- "newIndex": {
- "description": "The index of the new rule.",
- "format": "int32",
- "type": "integer"
- },
"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"
},
"newRule": {
- "$ref": "ConditionalFormatRule",
- "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)"
+ "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)",
+ "$ref": "ConditionalFormatRule"
},
"oldRule": {
- "description": "The old (deleted) rule. Not set if a rule was moved\n(because it is the same as new_rule).",
- "$ref": "ConditionalFormatRule"
+ "$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"
},
"ConditionValue": {
- "description": "The value of the condition.",
- "type": "object",
"properties": {
"relativeDate": {
+ "enum": [
+ "RELATIVE_DATE_UNSPECIFIED",
+ "PAST_YEAR",
+ "PAST_MONTH",
+ "PAST_WEEK",
+ "YESTERDAY",
+ "TODAY",
+ "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",
"enumDescriptions": [
@@ -1661,35 +4588,21 @@
"The value is yesterday.",
"The value is today.",
"The value is tomorrow."
- ],
- "enum": [
- "RELATIVE_DATE_UNSPECIFIED",
- "PAST_YEAR",
- "PAST_MONTH",
- "PAST_WEEK",
- "YESTERDAY",
- "TODAY",
- "TOMORROW"
]
},
"userEnteredValue": {
- "type": "string",
- "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 `=`)."
+ "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"
+ "id": "ConditionValue",
+ "description": "The value of the condition.",
+ "type": "object"
},
"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": {
- "type": "integer",
- "description": "The sheet to duplicate.",
- "format": "int32"
- },
"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",
@@ -1699,3729 +4612,29 @@
"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",
- "description": "Duplicates the contents of a sheet.",
- "type": "object"
- },
- "ExtendedValue": {
- "id": "ExtendedValue",
- "description": "The kinds of value that a cell in a spreadsheet can have.",
- "type": "object",
- "properties": {
- "errorValue": {
- "description": "Represents an error.\nThis field is read-only.",
- "$ref": "ErrorValue"
},
- "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\"`.",
+ "newSheetName": {
+ "description": "The name of the new sheet. If empty, a new name is chosen for you.",
"type": "string"
},
- "boolValue": {
- "description": "Represents a boolean value.",
- "type": "boolean"
- },
- "formulaValue": {
- "description": "Represents a formula.",
- "type": "string"
- },
- "numberValue": {
- "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format.",
- "format": "double",
- "type": "number"
- }
- }
- },
- "BandedRange": {
- "description": "A banded (alternating colors) range in a sheet.",
- "type": "object",
- "properties": {
- "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."
- },
- "range": {
- "description": "The range over which these properties are applied.",
- "$ref": "GridRange"
- },
- "bandedRangeId": {
- "description": "The id of the banded range.",
+ "sourceSheetId": {
+ "description": "The sheet to duplicate.",
"format": "int32",
"type": "integer"
}
},
- "id": "BandedRange"
- },
- "HistogramSeries": {
- "description": "A histogram series containing the series color and data.",
- "type": "object",
- "properties": {
- "data": {
- "description": "The data for this histogram series.",
- "$ref": "ChartData"
- },
- "barColor": {
- "description": "The color of the column representing this series in each bucket.\nThis field is optional.",
- "$ref": "Color"
- }
- },
- "id": "HistogramSeries"
- },
- "BatchClearValuesResponse": {
- "id": "BatchClearValuesResponse",
- "description": "The response when clearing a range of values in a spreadsheet.",
- "type": "object",
- "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"
- }
- }
- },
- "Spreadsheet": {
- "description": "Resource that represents a spreadsheet.",
- "type": "object",
- "properties": {
- "developerMetadata": {
- "description": "The developer metadata associated with a spreadsheet.",
- "type": "array",
- "items": {
- "$ref": "DeveloperMetadata"
- }
- },
- "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"
- },
- "properties": {
- "$ref": "SpreadsheetProperties",
- "description": "Overall properties of a spreadsheet."
- },
- "spreadsheetId": {
- "description": "The ID of the spreadsheet.\nThis field is read-only.",
- "type": "string"
- },
- "namedRanges": {
- "description": "The named ranges defined in a spreadsheet.",
- "type": "array",
- "items": {
- "$ref": "NamedRange"
- }
- }
- },
- "id": "Spreadsheet"
- },
- "AddChartRequest": {
- "id": "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"
- }
- }
- },
- "UpdateProtectedRangeRequest": {
- "description": "Updates an existing protected range with the specified\nprotectedRangeId.",
- "type": "object",
- "properties": {
- "protectedRange": {
- "$ref": "ProtectedRange",
- "description": "The protected range to update with the new properties."
- },
- "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.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateProtectedRangeRequest"
- },
- "DataFilter": {
- "description": "Filter that describes what data should be selected or returned from a\nrequest.",
- "type": "object",
- "properties": {
- "gridRange": {
- "$ref": "GridRange",
- "description": "Selects data that matches the range described by the GridRange."
- },
- "developerMetadataLookup": {
- "description": "Selects data associated with the developer metadata matching the criteria\ndescribed by this DeveloperMetadataLookup.",
- "$ref": "DeveloperMetadataLookup"
- },
- "a1Range": {
- "description": "Selects data that matches the specified A1 range.",
- "type": "string"
- }
- },
- "id": "DataFilter"
- },
- "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"
- },
- "bold": {
- "description": "True if the text is bold.",
- "type": "boolean"
- },
- "foregroundColor": {
- "description": "The foreground color of the text.",
- "$ref": "Color"
- },
- "fontFamily": {
- "description": "The font family.",
- "type": "string"
- },
- "strikethrough": {
- "description": "True if the text has a strikethrough.",
- "type": "boolean"
- },
- "italic": {
- "description": "True if the text is italicized.",
- "type": "boolean"
- },
- "fontSize": {
- "description": "The size of the font.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "AddSheetResponse": {
- "description": "The result of adding a sheet.",
- "type": "object",
- "properties": {
- "properties": {
- "$ref": "SheetProperties",
- "description": "The properties of the newly added sheet."
- }
- },
- "id": "AddSheetResponse"
- },
- "AddFilterViewResponse": {
- "description": "The result of adding a filter view.",
- "type": "object",
- "properties": {
- "filter": {
- "$ref": "FilterView",
- "description": "The newly added filter view."
- }
- },
- "id": "AddFilterViewResponse"
- },
- "IterativeCalculationSettings": {
- "description": "Settings to control how circular dependencies are resolved with iterative\ncalculation.",
- "type": "object",
- "properties": {
- "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": {
- "anchorCell": {
- "$ref": "GridCoordinate",
- "description": "The cell the object is anchored to."
- },
- "offsetYPixels": {
- "description": "The vertical offset, in pixels, that the object is offset\nfrom the anchor cell.",
- "format": "int32",
- "type": "integer"
- },
- "heightPixels": {
- "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": {
- "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."
- ],
- "enum": [
- "RECALCULATION_INTERVAL_UNSPECIFIED",
- "ON_CHANGE",
- "MINUTE",
- "HOUR"
- ],
- "description": "The amount of time to wait before volatile functions are recalculated."
- },
- "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."
- },
- "title": {
- "description": "The title of the spreadsheet.",
- "type": "string"
- },
- "timeZone": {
- "type": "string",
- "description": "The time zone of the spreadsheet, in CLDR format such as\n`America/New_York`. If the time zone isn't recognized, this may\nbe a custom time zone such as `GMT-07:00`."
- },
- "locale": {
- "type": "string",
- "description": "The locale of the spreadsheet in one of the following formats:\n\n* an ISO 639-1 language code such as `en`\n\n* an ISO 639-2 language code such as `fil`, if no 639-1 code exists\n\n* a combination of the ISO language code and country code, such as `en_US`\n\nNote: when updating this field, not all locales/languages are supported."
- },
- "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.",
- "$ref": "IterativeCalculationSettings"
- }
- },
- "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"
- }
- }
- },
- "AddChartResponse": {
- "id": "AddChartResponse",
- "description": "The result of adding a chart to a spreadsheet.",
- "type": "object",
- "properties": {
- "chart": {
- "description": "The newly added chart.",
- "$ref": "EmbeddedChart"
- }
- }
- },
- "InsertDimensionRequest": {
- "description": "Inserts rows or columns in a sheet at a particular index.",
- "type": "object",
- "properties": {
- "range": {
- "description": "The dimensions to insert. Both the start and end indexes must be bounded.",
- "$ref": "DimensionRange"
- },
- "inheritFromBefore": {
- "description": "Whether dimension properties should be extended from the dimensions\nbefore or after the newly inserted dimensions.\nTrue to inherit from the dimensions before (in which case the start\nindex must be greater than 0), and false to inherit from the dimensions\nafter.\n\nFor example, if row index 0 has red background and row index 1\nhas a green background, then inserting 2 rows at index 1 can inherit\neither the green or red background. If `inheritFromBefore` is true,\nthe two new rows will be red (because the row before the insertion point\nwas red), whereas if `inheritFromBefore` is false, the two new rows will\nbe green (because the row after the insertion point was green).",
- "type": "boolean"
- }
- },
- "id": "InsertDimensionRequest"
- },
- "UpdateSpreadsheetPropertiesRequest": {
- "description": "Updates properties of a spreadsheet.",
- "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": "SpreadsheetProperties"
- }
- },
- "id": "UpdateSpreadsheetPropertiesRequest"
- },
- "ProtectedRange": {
- "properties": {
- "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": {
- "type": "boolean",
- "description": "True if the user who requested this protected range can edit the\nprotected area.\nThis field is read-only."
- },
- "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"
- },
- "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."
- },
- "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",
- "items": {
- "$ref": "GridRange"
- }
- },
- "namedRangeId": {
- "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.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ProtectedRange",
- "description": "A protected range.",
- "type": "object"
- },
- "BatchUpdateValuesRequest": {
- "description": "The request for updating more than one range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "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": {
- "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."
- ],
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ]
- },
- "data": {
- "description": "The new values to apply to the spreadsheet.",
- "type": "array",
- "items": {
- "$ref": "ValueRange"
- }
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "hiddenByUser": {
- "description": "True if this dimension is explicitly hidden.",
- "type": "boolean"
- },
- "developerMetadata": {
- "description": "The developer metadata associated with a single row or column.",
- "type": "array",
- "items": {
- "$ref": "DeveloperMetadata"
- }
- }
- },
- "id": "DimensionProperties"
- },
- "NamedRange": {
- "description": "A named range.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the named range.",
- "type": "string"
- },
- "namedRangeId": {
- "description": "The ID of the named range.",
- "type": "string"
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range this represents."
- }
- },
- "id": "NamedRange"
- },
- "DimensionRange": {
- "properties": {
- "dimension": {
- "description": "The dimension of the span.",
- "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"
- ]
- },
- "startIndex": {
- "description": "The start (inclusive) of the span, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "endIndex": {
- "description": "The end (exclusive) of the span, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "sheetId": {
- "type": "integer",
- "description": "The sheet this span is on.",
- "format": "int32"
- }
- },
- "id": "DimensionRange",
- "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"
- },
- "CutPasteRequest": {
- "properties": {
- "source": {
- "description": "The source data to cut.",
- "$ref": "GridRange"
- },
- "pasteType": {
- "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": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
- "type": "string"
- },
- "destination": {
- "description": "The top-left coordinate where the data should be pasted.",
- "$ref": "GridCoordinate"
- }
- },
- "id": "CutPasteRequest",
- "description": "Moves data from the source to the destination.",
- "type": "object"
- },
- "BasicChartSeries": {
- "properties": {
- "series": {
- "$ref": "ChartData",
- "description": "The data being visualized in this chart series."
- },
- "type": {
- "enum": [
- "BASIC_CHART_TYPE_UNSPECIFIED",
- "BAR",
- "LINE",
- "AREA",
- "COLUMN",
- "SCATTER",
- "COMBO",
- "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."
- ]
- },
- "targetAxis": {
- "enumDescriptions": [
- "Default value, do not use.",
- "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
- "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
- "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
- ],
- "enum": [
- "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
- "BOTTOM_AXIS",
- "LEFT_AXIS",
- "RIGHT_AXIS"
- ],
- "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.",
- "type": "string"
- }
- },
- "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": {
- "bottom": {
- "$ref": "Border",
- "description": "The bottom border of the cell."
- },
- "top": {
- "$ref": "Border",
- "description": "The top border of the cell."
- },
- "left": {
- "description": "The left border of the cell.",
- "$ref": "Border"
- },
- "right": {
- "$ref": "Border",
- "description": "The right border of the cell."
- }
- },
- "id": "Borders"
- },
- "AutoResizeDimensionsRequest": {
- "type": "object",
- "properties": {
- "dimensions": {
- "$ref": "DimensionRange",
- "description": "The dimensions to automatically resize."
- }
- },
- "id": "AutoResizeDimensionsRequest",
- "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension."
- },
- "UpdateBordersRequest": {
- "properties": {
- "right": {
- "description": "The border to put at the right of the range.",
- "$ref": "Border"
- },
- "range": {
- "$ref": "GridRange",
- "description": "The range whose borders should be updated."
- },
- "innerHorizontal": {
- "$ref": "Border",
- "description": "The horizontal border to put within the range."
- },
- "top": {
- "$ref": "Border",
- "description": "The border to put at the top of the range."
- },
- "left": {
- "description": "The border to put at the left of the range.",
- "$ref": "Border"
- },
- "bottom": {
- "description": "The border to put at the bottom of the range.",
- "$ref": "Border"
- },
- "innerVertical": {
- "$ref": "Border",
- "description": "The vertical border to put within 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"
- },
- "CellFormat": {
- "description": "The format of a cell.",
- "type": "object",
- "properties": {
- "numberFormat": {
- "description": "A format describing how number values should be represented to the user.",
- "$ref": "NumberFormat"
- },
- "hyperlinkDisplayType": {
- "enum": [
- "HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
- "LINKED",
- "PLAIN_TEXT"
- ],
- "description": "How a hyperlink, if it exists, should be displayed in the cell.",
- "type": "string",
- "enumDescriptions": [
- "The default value: the hyperlink is rendered. Do not use this.",
- "A hyperlink should be explicitly rendered.",
- "A hyperlink should not be rendered."
- ]
- },
- "horizontalAlignment": {
- "enumDescriptions": [
- "The horizontal alignment is not specified. Do not use this.",
- "The text is explicitly aligned to the left of the cell.",
- "The text is explicitly aligned to the center of the cell.",
- "The text is explicitly aligned to the right of the cell."
- ],
- "enum": [
- "HORIZONTAL_ALIGN_UNSPECIFIED",
- "LEFT",
- "CENTER",
- "RIGHT"
- ],
- "description": "The horizontal alignment of the value in the cell.",
- "type": "string"
- },
- "textFormat": {
- "$ref": "TextFormat",
- "description": "The format of the text in the cell (unless overridden by a format run)."
- },
- "backgroundColor": {
- "description": "The background color of the cell.",
- "$ref": "Color"
- },
- "padding": {
- "description": "The padding of the cell.",
- "$ref": "Padding"
- },
- "verticalAlignment": {
- "enumDescriptions": [
- "The vertical alignment is not specified. Do not use this.",
- "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"
- ],
- "description": "The vertical alignment of the value in the cell.",
- "type": "string"
- },
- "borders": {
- "description": "The borders of the cell.",
- "$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.",
- "The text direction of right-to-left was set by the user."
- ],
- "enum": [
- "TEXT_DIRECTION_UNSPECIFIED",
- "LEFT_TO_RIGHT",
- "RIGHT_TO_LEFT"
- ]
- },
- "wrapStrategy": {
- "description": "The wrap strategy for the value in the cell.",
- "type": "string",
- "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"
- ]
- },
- "textRotation": {
- "description": "The rotation applied to text in a cell",
- "$ref": "TextRotation"
- }
- },
- "id": "CellFormat"
- },
- "ClearValuesResponse": {
- "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"
- }
- },
- "id": "ClearValuesResponse"
- },
- "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.",
- "format": "int32",
- "type": "integer"
- },
- "sheetId": {
- "description": "The sheet the rule is being deleted from.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteConditionalFormatRuleRequest"
- },
- "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": {
- "description": "The result of adding a banded range.",
- "type": "object",
- "properties": {
- "bandedRange": {
- "$ref": "BandedRange",
- "description": "The banded range that was added."
- }
- },
- "id": "AddBandingResponse"
- },
- "ChartData": {
- "type": "object",
- "properties": {
- "sourceRange": {
- "description": "The source ranges of the data.",
- "$ref": "ChartSourceRange"
- }
- },
- "id": "ChartData",
- "description": "The data included in a domain or series."
- },
- "BatchGetValuesResponse": {
- "id": "BatchGetValuesResponse",
- "description": "The response when retrieving more than one range of values in a spreadsheet.",
- "type": "object",
- "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"
- }
- }
- },
- "UpdateBandingRequest": {
- "properties": {
- "bandedRange": {
- "description": "The banded range to update with the new properties.",
- "$ref": "BandedRange"
- },
- "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",
- "description": "Updates properties of the supplied banded range.",
- "type": "object"
- },
- "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": {
- "id": "PivotGroup",
- "description": "A single grouping (either row or column) in a pivot table.",
- "type": "object",
- "properties": {
- "sortOrder": {
- "enumDescriptions": [
- "Default value, do not use this.",
- "Sort ascending.",
- "Sort descending."
- ],
- "enum": [
- "SORT_ORDER_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ],
- "description": "The order the values in this group should be sorted.",
- "type": "string"
- },
- "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": {
- "description": "Metadata about values in the grouping.",
- "type": "array",
- "items": {
- "$ref": "PivotGroupValueMetadata"
- }
- }
- }
- },
- "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)."
- ]
- },
- "source": {
- "description": "The range the pivot table is reading data from.",
- "$ref": "GridRange"
- },
- "columns": {
- "description": "Each column grouping in the pivot table.",
- "type": "array",
- "items": {
- "$ref": "PivotGroup"
- }
- },
- "values": {
- "description": "A list of values to include in the pivot table.",
- "type": "array",
- "items": {
- "$ref": "PivotValue"
- }
- }
- },
- "id": "PivotTable"
- },
- "ChartSourceRange": {
- "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",
- "description": "Source ranges for a chart."
- },
- "SearchDeveloperMetadataResponse": {
- "description": "A reply to a developer metadata search request.",
- "type": "object",
- "properties": {
- "matchedDeveloperMetadata": {
- "description": "The metadata matching the criteria of the search request.",
- "type": "array",
- "items": {
- "$ref": "MatchedDeveloperMetadata"
- }
- }
- },
- "id": "SearchDeveloperMetadataResponse"
- },
- "ValueRange": {
- "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": {
- "type": "string",
- "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."
- }
- },
- "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": {
- "type": "string",
- "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"
- },
- "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": {
- "$ref": "AddFilterViewResponse",
- "description": "A reply from adding a filter view."
- },
- "addBanding": {
- "$ref": "AddBandingResponse",
- "description": "A reply from adding a banded range."
- },
- "addProtectedRange": {
- "description": "A reply from adding a protected range.",
- "$ref": "AddProtectedRangeResponse"
- },
- "duplicateSheet": {
- "$ref": "DuplicateSheetResponse",
- "description": "A reply from duplicating a sheet."
- },
- "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": {
- "description": "A reply from duplicating a filter view.",
- "$ref": "DuplicateFilterViewResponse"
- },
- "addChart": {
- "description": "A reply from adding a chart.",
- "$ref": "AddChartResponse"
- },
- "updateDeveloperMetadata": {
- "$ref": "UpdateDeveloperMetadataResponse",
- "description": "A reply from updating a developer metadata entry."
- },
- "findReplace": {
- "description": "A reply from doing a find/replace.",
- "$ref": "FindReplaceResponse"
- },
- "addSheet": {
- "description": "A reply from adding a sheet.",
- "$ref": "AddSheetResponse"
- },
- "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": {
- "description": "A reply from deleting a developer metadata entry.",
- "$ref": "DeleteDeveloperMetadataResponse"
- }
- },
- "id": "Response"
- },
- "InsertRangeRequest": {
- "description": "Inserts cells into a range, shifting the existing cells over or down.",
- "type": "object",
- "properties": {
- "shiftDimension": {
- "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",
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ]
- },
- "range": {
- "description": "The range to insert new cells into.",
- "$ref": "GridRange"
- }
- },
- "id": "InsertRangeRequest"
- },
- "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": {
- "startIndex": {
- "description": "The character index where this run starts.",
- "format": "int32",
- "type": "integer"
- },
- "format": {
- "description": "The format of this run. Absent values inherit the cell's format.",
- "$ref": "TextFormat"
- }
- },
- "id": "TextFormatRun"
- },
- "EmbeddedChart": {
- "id": "EmbeddedChart",
- "description": "A chart embedded in a sheet.",
- "type": "object",
- "properties": {
- "spec": {
- "description": "The specification of the chart.",
- "$ref": "ChartSpec"
- },
- "chartId": {
- "description": "The ID of the chart.",
- "format": "int32",
- "type": "integer"
- },
- "position": {
- "$ref": "EmbeddedObjectPosition",
- "description": "The position of the chart."
- }
- }
- },
- "AddNamedRangeResponse": {
- "description": "The result of adding a named range.",
- "type": "object",
- "properties": {
- "namedRange": {
- "description": "The named range to add.",
- "$ref": "NamedRange"
- }
- },
- "id": "AddNamedRangeResponse"
- },
- "BatchUpdateValuesByDataFilterResponse": {
- "properties": {
- "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": {
- "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"
- }
- },
- "id": "BatchUpdateValuesByDataFilterResponse",
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object"
- },
- "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": {
- "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": {
- "type": "integer",
- "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
- "format": "int32"
- }
- },
- "id": "Border"
- },
- "GridData": {
- "properties": {
- "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"
- }
- },
- "startColumn": {
- "description": "The first column this GridData refers to, zero-based.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GridData",
- "description": "Data in the grid, as well as metadata about the dimensions.",
- "type": "object"
- },
- "UpdateNamedRangeRequest": {
- "description": "Updates properties of the named range with the specified\nnamedRangeId.",
- "type": "object",
- "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"
- },
- "FindReplaceRequest": {
- "description": "Finds and replaces data in cells over a range, sheet, or all sheets.",
- "type": "object",
- "properties": {
- "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": {
- "type": "integer",
- "description": "The sheet to find/replace over.",
- "format": "int32"
- },
- "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": {
- "type": "boolean",
- "description": "True if the find value should match the entire cell."
- }
- },
- "id": "FindReplaceRequest"
- },
- "AddSheetRequest": {
- "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",
- "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."
- },
- "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": {
- "$ref": "GridRange",
- "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."
- },
- "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"
- },
- "DeleteConditionalFormatRuleResponse": {
- "description": "The result of deleting a conditional format rule.",
- "type": "object",
- "properties": {
- "rule": {
- "$ref": "ConditionalFormatRule",
- "description": "The rule that was deleted."
- }
- },
- "id": "DeleteConditionalFormatRuleResponse"
- },
- "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": {
- "description": "Updates properties of the sheet with the specified\nsheetId.",
- "type": "object",
- "properties": {
- "properties": {
- "$ref": "SheetProperties",
- "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"
- }
- },
- "id": "UpdateSheetPropertiesRequest"
- },
- "UnmergeCellsRequest": {
- "description": "Unmerges cells in the given range.",
- "type": "object",
- "properties": {
- "range": {
- "$ref": "GridRange",
- "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."
- }
- },
- "id": "UnmergeCellsRequest"
- },
- "GridProperties": {
- "description": "Properties of a grid.",
- "type": "object",
- "properties": {
- "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"
- },
- "rowCount": {
- "description": "The number of rows in the grid.",
- "format": "int32",
- "type": "integer"
- },
- "frozenRowCount": {
- "type": "integer",
- "description": "The number of rows that are frozen in the grid.",
- "format": "int32"
- },
- "hideGridlines": {
- "description": "True if the grid isn't showing gridlines in the UI.",
- "type": "boolean"
- }
- },
- "id": "GridProperties"
- },
- "UpdateEmbeddedObjectPositionResponse": {
- "description": "The result of updating an embedded object's position.",
- "type": "object",
- "properties": {
- "position": {
- "description": "The new position of the embedded object.",
- "$ref": "EmbeddedObjectPosition"
- }
- },
- "id": "UpdateEmbeddedObjectPositionResponse"
- },
- "Sheet": {
- "id": "Sheet",
- "description": "A sheet in a spreadsheet.",
- "type": "object",
- "properties": {
- "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": {
- "description": "The properties of the sheet.",
- "$ref": "SheetProperties"
- },
- "filterViews": {
- "description": "The filter views in this sheet.",
- "type": "array",
- "items": {
- "$ref": "FilterView"
- }
- },
- "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": {
- "type": "array",
- "items": {
- "$ref": "ProtectedRange"
- },
- "description": "The protected ranges in this sheet."
- },
- "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"
- }
- }
- }
- },
- "SortSpec": {
- "type": "object",
- "properties": {
- "sortOrder": {
- "enumDescriptions": [
- "Default value, do not use this.",
- "Sort ascending.",
- "Sort descending."
- ],
- "enum": [
- "SORT_ORDER_UNSPECIFIED",
- "ASCENDING",
- "DESCENDING"
- ],
- "description": "The order data should be sorted.",
- "type": "string"
- },
- "dimensionIndex": {
- "type": "integer",
- "description": "The dimension the sort should be applied to.",
- "format": "int32"
- }
- },
- "id": "SortSpec",
- "description": "A sort order associated with a specific column or row."
- },
- "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": {
- "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color.",
- "$ref": "CellFormat"
- }
- },
- "id": "BooleanRule"
- },
- "FilterCriteria": {
- "type": "object",
- "properties": {
- "hiddenValues": {
- "description": "Values that should be hidden.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "condition": {
- "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.)",
- "$ref": "BooleanCondition"
- }
- },
- "id": "FilterCriteria",
- "description": "Criteria for showing/hiding rows in a filter or filter view."
- },
- "PivotGroupValueMetadata": {
- "description": "Metadata about a value in a pivot grouping.",
- "type": "object",
- "properties": {
- "value": {
- "$ref": "ExtendedValue",
- "description": "The calculated value the metadata corresponds to.\n(Note that formulaValue is not valid,\n because the values will be calculated.)"
- },
- "collapsed": {
- "description": "True if the data corresponding to the value is collapsed.",
- "type": "boolean"
- }
- },
- "id": "PivotGroupValueMetadata"
- },
- "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": {
- "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"
- },
- "UpdateConditionalFormatRuleRequest": {
- "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": {
- "type": "integer",
- "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.",
- "format": "int32"
- },
- "newIndex": {
- "description": "The zero-based new index the rule should end up at.",
- "format": "int32",
- "type": "integer"
- }
- },
- "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": {
- "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",
- "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": {
- "$ref": "BooleanCondition",
- "description": "The condition that data in the cell must match."
- }
- },
- "id": "DataValidationRule"
- },
- "PasteDataRequest": {
- "id": "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": {
- "type": "string",
- "description": "The data to insert."
- },
- "delimiter": {
- "description": "The delimiter in the data.",
- "type": "string"
- },
- "type": {
- "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.",
- "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."
- ]
- },
- "html": {
- "description": "True if the data is HTML.",
- "type": "boolean"
- }
- }
- },
- "UpdateDeveloperMetadataResponse": {
- "type": "object",
- "properties": {
- "developerMetadata": {
- "description": "The updated developer metadata.",
- "type": "array",
- "items": {
- "$ref": "DeveloperMetadata"
- }
- }
- },
- "id": "UpdateDeveloperMetadataResponse",
- "description": "The response from updating developer metadata."
- },
- "AppendDimensionRequest": {
- "description": "Appends rows or columns to the end of a sheet.",
- "type": "object",
- "properties": {
- "dimension": {
- "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."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ]
- },
- "length": {
- "type": "integer",
- "description": "The number of rows or columns to append.",
- "format": "int32"
- },
- "sheetId": {
- "description": "The sheet to append rows or columns to.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "AppendDimensionRequest"
- },
- "AddNamedRangeRequest": {
- "id": "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.)"
- }
- }
- },
- "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": {
- "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."
- },
- "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"
- }
- },
- "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": {
- "properties": {
- "domain": {
- "description": "The data that covers the domain of the pie chart.",
- "$ref": "ChartData"
- },
- "threeDimensional": {
- "description": "True if the pie is three dimensional.",
- "type": "boolean"
- },
- "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"
- }
- },
- "id": "PieChartSpec",
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/piechart\"\u003epie chart\u003c/a\u003e.",
- "type": "object"
- },
- "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": {
- "description": "The value that all metadata matched by the data filters will be updated to.",
- "$ref": "DeveloperMetadata"
- }
- },
- "id": "UpdateDeveloperMetadataRequest"
- },
- "UpdateFilterViewRequest": {
- "description": "Updates properties of the filter view.",
- "type": "object",
- "properties": {
- "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.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "filter": {
- "$ref": "FilterView",
- "description": "The new properties of the filter view."
- }
- },
- "id": "UpdateFilterViewRequest"
- },
- "ConditionalFormatRule": {
- "description": "A rule describing a conditional format.",
- "type": "object",
- "properties": {
- "ranges": {
- "description": "The ranges that will be formatted if the condition is true.\nAll the ranges must be on the same grid.",
- "type": "array",
- "items": {
- "$ref": "GridRange"
- }
- },
- "gradientRule": {
- "$ref": "GradientRule",
- "description": "The formatting will vary based on the gradients in the rule."
- },
- "booleanRule": {
- "description": "The formatting is either \"on\" or \"off\" according to the rule.",
- "$ref": "BooleanRule"
- }
- },
- "id": "ConditionalFormatRule"
- },
- "CopyPasteRequest": {
- "properties": {
- "destination": {
- "$ref": "GridRange",
- "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)."
- },
- "pasteOrientation": {
- "enumDescriptions": [
- "Paste normally.",
- "Paste transposed, where all rows become columns and vice versa."
- ],
- "enum": [
- "NORMAL",
- "TRANSPOSE"
- ],
- "description": "How that data should be oriented when pasting.",
- "type": "string"
- },
- "source": {
- "description": "The source range to copy.",
- "$ref": "GridRange"
- },
- "pasteType": {
- "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": "What kind of data to paste.",
- "type": "string"
- }
- },
- "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": {
- "randomizeRange": {
- "$ref": "RandomizeRangeRequest",
- "description": "Randomizes the order of the rows in a range."
- },
- "updateBanding": {
- "$ref": "UpdateBandingRequest",
- "description": "Updates a banded range"
- },
- "deleteNamedRange": {
- "$ref": "DeleteNamedRangeRequest",
- "description": "Deletes a named range."
- },
- "addProtectedRange": {
- "description": "Adds a protected range.",
- "$ref": "AddProtectedRangeRequest"
- },
- "duplicateSheet": {
- "description": "Duplicates a sheet.",
- "$ref": "DuplicateSheetRequest"
- },
- "unmergeCells": {
- "$ref": "UnmergeCellsRequest",
- "description": "Unmerges merged cells."
- },
- "deleteSheet": {
- "$ref": "DeleteSheetRequest",
- "description": "Deletes a sheet."
- },
- "updateEmbeddedObjectPosition": {
- "description": "Updates an embedded object's (e.g. chart, image) position.",
- "$ref": "UpdateEmbeddedObjectPositionRequest"
- },
- "updateDeveloperMetadata": {
- "description": "Updates an existing developer metadata entry",
- "$ref": "UpdateDeveloperMetadataRequest"
- },
- "updateDimensionProperties": {
- "description": "Updates dimensions' properties.",
- "$ref": "UpdateDimensionPropertiesRequest"
- },
- "pasteData": {
- "description": "Pastes data (HTML or delimited) into a sheet.",
- "$ref": "PasteDataRequest"
- },
- "setBasicFilter": {
- "$ref": "SetBasicFilterRequest",
- "description": "Sets the basic filter on a sheet."
- },
- "addConditionalFormatRule": {
- "$ref": "AddConditionalFormatRuleRequest",
- "description": "Adds a new conditional format rule."
- },
- "updateCells": {
- "$ref": "UpdateCellsRequest",
- "description": "Updates many cells at once."
- },
- "addNamedRange": {
- "description": "Adds a named range.",
- "$ref": "AddNamedRangeRequest"
- },
- "updateSpreadsheetProperties": {
- "description": "Updates the spreadsheet's properties.",
- "$ref": "UpdateSpreadsheetPropertiesRequest"
- },
- "deleteEmbeddedObject": {
- "description": "Deletes an embedded object (e.g, chart, image) in a sheet.",
- "$ref": "DeleteEmbeddedObjectRequest"
- },
- "updateFilterView": {
- "description": "Updates the properties of a filter view.",
- "$ref": "UpdateFilterViewRequest"
- },
- "addBanding": {
- "$ref": "AddBandingRequest",
- "description": "Adds a new banded range"
- },
- "autoResizeDimensions": {
- "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
- "$ref": "AutoResizeDimensionsRequest"
- },
- "appendCells": {
- "$ref": "AppendCellsRequest",
- "description": "Appends cells after the last row with data in a sheet."
- },
- "cutPaste": {
- "$ref": "CutPasteRequest",
- "description": "Cuts data from one area and pastes it to another."
- },
- "mergeCells": {
- "$ref": "MergeCellsRequest",
- "description": "Merges cells together."
- },
- "updateNamedRange": {
- "$ref": "UpdateNamedRangeRequest",
- "description": "Updates a named range."
- },
- "updateSheetProperties": {
- "$ref": "UpdateSheetPropertiesRequest",
- "description": "Updates a sheet's properties."
- },
- "autoFill": {
- "$ref": "AutoFillRequest",
- "description": "Automatically fills in more data based on existing data."
- },
- "deleteDimension": {
- "$ref": "DeleteDimensionRequest",
- "description": "Deletes rows or columns in a sheet."
- },
- "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": {
- "description": "Adds a chart.",
- "$ref": "AddChartRequest"
- },
- "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": {
- "description": "Updates a chart's specifications.",
- "$ref": "UpdateChartSpecRequest"
- },
- "updateProtectedRange": {
- "$ref": "UpdateProtectedRangeRequest",
- "description": "Updates a protected range."
- },
- "addSheet": {
- "$ref": "AddSheetRequest",
- "description": "Adds a sheet."
- },
- "copyPaste": {
- "description": "Copies data from one area and pastes it to another.",
- "$ref": "CopyPasteRequest"
- },
- "deleteFilterView": {
- "$ref": "DeleteFilterViewRequest",
- "description": "Deletes a filter view from a sheet."
- },
- "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": {
- "$ref": "DeleteBandingRequest",
- "description": "Removes a banded range"
- },
- "addFilterView": {
- "description": "Adds a filter view.",
- "$ref": "AddFilterViewRequest"
- },
- "setDataValidation": {
- "$ref": "SetDataValidationRequest",
- "description": "Sets data validation for one or more cells."
- },
- "updateBorders": {
- "$ref": "UpdateBordersRequest",
- "description": "Updates the borders in a range of cells."
- },
- "deleteConditionalFormatRule": {
- "$ref": "DeleteConditionalFormatRuleRequest",
- "description": "Deletes an existing conditional format rule."
- },
- "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."
- },
- "createDeveloperMetadata": {
- "$ref": "CreateDeveloperMetadataRequest",
- "description": "Creates new developer metadata"
- },
- "updateConditionalFormatRule": {
- "$ref": "UpdateConditionalFormatRuleRequest",
- "description": "Updates an existing conditional format rule."
- },
- "insertRange": {
- "$ref": "InsertRangeRequest",
- "description": "Inserts new cells in a sheet, shifting the existing cells."
- },
- "deleteDeveloperMetadata": {
- "$ref": "DeleteDeveloperMetadataRequest",
- "description": "Deletes developer metadata"
- },
- "moveDimension": {
- "$ref": "MoveDimensionRequest",
- "description": "Moves rows or columns to another location 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": [
- "The default value, do not use.",
- "The cell's value must be greater than the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be greater than or equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be less than the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be less than or equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be not equal to the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
- "The cell's value must not be between the two condition values.\nSupported by data validation, conditional formatting and filters.\nRequires exactly two ConditionValues.",
- "The cell's value must contain the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must not contain the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must start with the condition's value.\nSupported by conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must end with the condition's value.\nSupported by conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be exactly the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be a valid email address.\nSupported by data validation.\nRequires no ConditionValues.",
- "The cell's value must be a valid URL.\nSupported by data validation.\nRequires no ConditionValues.",
- "The cell's value must be the same date as the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue.",
- "The cell's value must be before the date of the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue\nthat may be a relative date.",
- "The cell's value must be after the date of the condition's value.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue\nthat may be a relative date.",
- "The cell's value must be on or before the date of the condition's value.\nSupported by data validation.\nRequires a single ConditionValue\nthat may be a relative date.",
- "The cell's value must be on or after the date of the condition's value.\nSupported by data validation.\nRequires a single ConditionValue\nthat may be a relative date.",
- "The cell's value must be between the dates of the two condition values.\nSupported by data validation.\nRequires exactly two ConditionValues.",
- "The cell's value must be outside the dates of the two condition values.\nSupported by data validation.\nRequires exactly two ConditionValues.",
- "The cell's value must be a date.\nSupported by data validation.\nRequires no ConditionValues.",
- "The cell's value must be listed in the grid in condition value's range.\nSupported by data validation.\nRequires a single ConditionValue,\nand the value must be a valid range in A1 notation.",
- "The cell's value must in the list of condition values.\nSupported by data validation.\nSupports any number of condition values,\none per item in the list.\nFormulas are not supported in the values.",
- "The cell's value must be empty.\nSupported by conditional formatting and filters.\nRequires no ConditionValues.",
- "The cell's value must not be empty.\nSupported by conditional formatting and filters.\nRequires no ConditionValues.",
- "The condition's formula must evaluate to true.\nSupported by data validation, conditional formatting and filters.\nRequires a single ConditionValue."
- ],
- "enum": [
- "CONDITION_TYPE_UNSPECIFIED",
- "NUMBER_GREATER",
- "NUMBER_GREATER_THAN_EQ",
- "NUMBER_LESS",
- "NUMBER_LESS_THAN_EQ",
- "NUMBER_EQ",
- "NUMBER_NOT_EQ",
- "NUMBER_BETWEEN",
- "NUMBER_NOT_BETWEEN",
- "TEXT_CONTAINS",
- "TEXT_NOT_CONTAINS",
- "TEXT_STARTS_WITH",
- "TEXT_ENDS_WITH",
- "TEXT_EQ",
- "TEXT_IS_EMAIL",
- "TEXT_IS_URL",
- "DATE_EQ",
- "DATE_BEFORE",
- "DATE_AFTER",
- "DATE_ON_OR_BEFORE",
- "DATE_ON_OR_AFTER",
- "DATE_BETWEEN",
- "DATE_NOT_BETWEEN",
- "DATE_IS_VALID",
- "ONE_OF_RANGE",
- "ONE_OF_LIST",
- "BLANK",
- "NOT_BLANK",
- "CUSTOM_FORMULA"
- ],
- "description": "The type of condition.",
- "type": "string"
- },
- "values": {
- "description": "The values of the condition. The number of supported values depends\non the condition type. Some support zero values,\nothers one or two values,\nand ConditionType.ONE_OF_LIST supports an arbitrary number of values.",
- "type": "array",
- "items": {
- "$ref": "ConditionValue"
- }
- }
- },
- "id": "BooleanCondition"
- },
- "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": {
- "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",
- "type": "integer"
- },
- "endColumnIndex": {
- "description": "The end column (exclusive) of the range, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "startRowIndex": {
- "description": "The start row (inclusive) of the range, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "startColumnIndex": {
- "description": "The start column (inclusive) of the range, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GridRange"
- },
- "BasicChartSpec": {
- "description": "The specification for a basic chart. See BasicChartType for the list\nof charts this supports.",
- "type": "object",
- "properties": {
- "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",
- "items": {
- "$ref": "BasicChartAxis"
- }
- },
- "threeDimensional": {
- "description": "True to make the chart 3D.\nApplies to Bar and Column charts.",
- "type": "boolean"
- },
- "chartType": {
- "enum": [
- "BASIC_CHART_TYPE_UNSPECIFIED",
- "BAR",
- "LINE",
- "AREA",
- "COLUMN",
- "SCATTER",
- "COMBO",
- "STEPPED_AREA"
- ],
- "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.",
- "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."
- ]
- },
- "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.",
- "type": "array",
- "items": {
- "$ref": "BasicChartSeries"
- }
- },
- "legendPosition": {
- "enum": [
- "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
- "BOTTOM_LEGEND",
- "LEFT_LEGEND",
- "RIGHT_LEGEND",
- "TOP_LEGEND",
- "NO_LEGEND"
- ],
- "description": "The position of the chart legend.",
- "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."
- ]
- },
- "compareMode": {
- "enum": [
- "BASIC_CHART_COMPARE_MODE_UNSPECIFIED",
- "DATUM",
- "CATEGORY"
- ],
- "description": "The behavior of tooltips and data highlighting when hovering on data and\nchart area.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "Only the focused data element is highlighted and shown in the tooltip.",
- "All data elements with the same category (e.g., domain value) are\nhighlighted and shown in the tooltip."
- ]
- },
- "domains": {
- "description": "The domain of data this is charting.\nOnly a single domain is supported.",
- "type": "array",
- "items": {
- "$ref": "BasicChartDomain"
- }
- },
- "lineSmoothing": {
- "description": "Gets whether all lines should be rendered smooth or straight by default.\nApplies to Line charts.",
- "type": "boolean"
- }
- },
- "id": "BasicChartSpec"
- },
- "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": "SetDataValidationRequest"
- },
- "BubbleChartSpec": {
- "properties": {
- "legendPosition": {
- "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.",
- "The legend is rendered inside the chart area."
- ],
- "enum": [
- "BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED",
- "BOTTOM_LEGEND",
- "LEFT_LEGEND",
- "RIGHT_LEGEND",
- "TOP_LEGEND",
- "NO_LEGEND",
- "INSIDE_LEGEND"
- ],
- "description": "Where the legend of the chart should be drawn.",
- "type": "string"
- },
- "domain": {
- "$ref": "ChartData",
- "description": "The data containing the bubble x-values. These values locate the bubbles\nin the chart horizontally."
- },
- "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": {
- "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": {
- "$ref": "ChartData",
- "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."
- },
- "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"
- },
- "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": {
- "$ref": "ChartData",
- "description": "The data contianing the bubble y-values. These values locate the bubbles\nin the chart vertically."
- }
- },
- "id": "BubbleChartSpec",
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/bubblechart\"\u003ebubble chart\u003c/a\u003e.",
- "type": "object"
- },
- "CellData": {
- "id": "CellData",
- "description": "Data about a specific cell.",
- "type": "object",
- "properties": {
- "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",
- "items": {
- "$ref": "TextFormatRun"
- }
- },
- "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": {
- "$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": {
- "$ref": "CellFormat",
- "description": "The format the user entered for the cell.\n\nWhen writing, the new format will be merged with the existing format."
- },
- "note": {
- "type": "string",
- "description": "Any note on the cell."
- },
- "effectiveFormat": {
- "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.",
- "$ref": "CellFormat"
- },
- "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."
- },
- "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"
- },
- "effectiveValue": {
- "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.",
- "$ref": "ExtendedValue"
- }
- }
- },
- "BatchUpdateValuesByDataFilterRequest": {
- "id": "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\"`."
- ],
- "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": {
- "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."
- ],
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ]
- },
- "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"
- }
- }
- },
- "TextPosition": {
- "description": "Position settings for text.",
- "type": "object",
- "properties": {
- "horizontalAlignment": {
- "enumDescriptions": [
- "The horizontal alignment is not specified. Do not use this.",
- "The text is explicitly aligned to the left of the cell.",
- "The text is explicitly aligned to the center of the cell.",
- "The text is explicitly aligned to the right of the cell."
- ],
- "enum": [
- "HORIZONTAL_ALIGN_UNSPECIFIED",
- "LEFT",
- "CENTER",
- "RIGHT"
- ],
- "description": "Horizontal alignment setting for the piece of text.",
- "type": "string"
- }
- },
- "id": "TextPosition"
- },
- "BatchUpdateSpreadsheetRequest": {
- "id": "BatchUpdateSpreadsheetRequest",
- "description": "The request for updating any aspect of a spreadsheet.",
- "type": "object",
- "properties": {
- "includeSpreadsheetInResponse": {
- "type": "boolean",
- "description": "Determines if the update response should include the spreadsheet\nresource."
- },
- "responseRanges": {
- "description": "Limits the ranges included in the response spreadsheet.\nMeaningful only if include_spreadsheet_response is 'true'.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "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"
- }
- }
- }
- },
- "Padding": {
- "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",
- "type": "integer"
- },
- "bottom": {
- "description": "The bottom padding of the cell.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Padding"
- },
- "BasicChartAxis": {
- "properties": {
- "titleTextPosition": {
- "$ref": "TextPosition",
- "description": "The axis title text position."
- },
- "format": {
- "$ref": "TextFormat",
- "description": "The format of the title.\nOnly valid if the axis is not associated with the domain."
- },
- "position": {
- "enum": [
- "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
- "BOTTOM_AXIS",
- "LEFT_AXIS",
- "RIGHT_AXIS"
- ],
- "description": "The position of this axis.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
- "The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
- "The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
- ]
- },
- "title": {
- "description": "The title of this axis. If set, this overrides any title inferred\nfrom headers of the data.",
- "type": "string"
- }
- },
- "id": "BasicChartAxis",
- "description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position.",
- "type": "object"
- },
- "DeleteDimensionRequest": {
- "description": "Deletes the dimensions from the sheet.",
- "type": "object",
- "properties": {
- "range": {
- "$ref": "DimensionRange",
- "description": "The dimensions to delete from the sheet."
- }
- },
- "id": "DeleteDimensionRequest"
- },
- "UpdateChartSpecRequest": {
- "description": "Updates a chart's specifications.\n(This does not move or resize a chart. To move or resize a chart, use\n UpdateEmbeddedObjectPositionRequest.)",
- "type": "object",
- "properties": {
- "chartId": {
- "description": "The ID of the chart to update.",
- "format": "int32",
- "type": "integer"
- },
- "spec": {
- "$ref": "ChartSpec",
- "description": "The specification to apply to the chart."
- }
- },
- "id": "UpdateChartSpecRequest"
- },
- "DeleteFilterViewRequest": {
- "description": "Deletes a particular filter view.",
- "type": "object",
- "properties": {
- "filterId": {
- "description": "The ID of the filter to delete.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteFilterViewRequest"
- },
- "DeleteDeveloperMetadataResponse": {
- "id": "DeleteDeveloperMetadataResponse",
- "description": "The response from deleting developer metadata.",
- "type": "object",
- "properties": {
- "deletedDeveloperMetadata": {
- "description": "The metadata that was deleted.",
- "type": "array",
- "items": {
- "$ref": "DeveloperMetadata"
- }
- }
- }
- },
- "BatchGetValuesByDataFilterRequest": {
- "description": "The request for retrieving a range of values in a spreadsheet selected by a\nset of DataFilters.",
- "type": "object",
- "properties": {
- "dataFilters": {
- "type": "array",
- "items": {
- "$ref": "DataFilter"
- },
- "description": "The data filters used to match the ranges of values to retrieve. Ranges\nthat match any of the specified data filters will be included in the\nresponse."
- },
- "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"
- },
- "dateTimeRenderOption": {
- "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",
- "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)."
- ]
- },
- "majorDimension": {
- "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",
- "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"
- ]
- }
- },
- "id": "BatchGetValuesByDataFilterRequest"
- },
- "BatchUpdateValuesResponse": {
- "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": {
- "type": "array",
- "items": {
- "$ref": "UpdateValuesResponse"
- },
- "description": "One UpdateValuesResponse per requested range, in the same order as\nthe requests appeared."
- },
- "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"
- }
- },
- "id": "BatchUpdateValuesResponse"
- },
- "SortRangeRequest": {
- "description": "Sorts data in rows based on a sort order per column.",
- "type": "object",
- "properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range to sort."
- },
- "sortSpecs": {
- "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
- "type": "array",
- "items": {
- "$ref": "SortSpec"
- }
- }
- },
- "id": "SortRangeRequest"
- },
- "MergeCellsRequest": {
- "description": "Merges all cells in the range.",
- "type": "object",
- "properties": {
- "mergeType": {
- "enumDescriptions": [
- "Create a single merge from the range",
- "Create a merge for each column in the range",
- "Create a merge for each row in the range"
- ],
- "enum": [
- "MERGE_ALL",
- "MERGE_COLUMNS",
- "MERGE_ROWS"
- ],
- "description": "How the cells should be merged.",
- "type": "string"
- },
- "range": {
- "description": "The range of cells to merge.",
- "$ref": "GridRange"
- }
- },
- "id": "MergeCellsRequest"
- },
- "MatchedDeveloperMetadata": {
- "type": "object",
- "properties": {
- "dataFilters": {
- "description": "All filters matching the returned developer metadata.",
- "type": "array",
- "items": {
- "$ref": "DataFilter"
- }
- },
- "developerMetadata": {
- "$ref": "DeveloperMetadata",
- "description": "The developer metadata matching the specified filters."
- }
- },
- "id": "MatchedDeveloperMetadata",
- "description": "A developer metadata entry and the data filters specified in the original\nrequest that matched it."
- },
- "AddProtectedRangeRequest": {
- "description": "Adds a new protected range.",
- "type": "object",
- "properties": {
- "protectedRange": {
- "$ref": "ProtectedRange",
- "description": "The protected range to be added. The\nprotectedRangeId field is optional; if\none is not set, an id will be randomly generated. (It is an error to\nspecify the ID of a range that already exists.)"
- }
- },
- "id": "AddProtectedRangeRequest"
- },
- "BatchClearValuesRequest": {
- "description": "The request for clearing more than one range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "ranges": {
- "description": "The ranges to clear, in A1 notation.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "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": {
- "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": {
- "type": "string",
- "description": "Data associated with the metadata's key."
- },
- "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"
- },
- "metadataId": {
- "description": "The spreadsheet-scoped unique ID that identifies the metadata. IDs may be\nspecified when metadata is created, otherwise one will be randomly\ngenerated and assigned. Must be positive.",
- "format": "int32",
- "type": "integer"
- },
- "location": {
- "description": "The location where the metadata is associated.",
- "$ref": "DeveloperMetadataLocation"
- },
- "visibility": {
- "enumDescriptions": [
- "Default value.",
- "Document-visible metadata is accessible from any developer project with\naccess to the document.",
- "Project-visible metadata is only visible to and accessible by the developer\nproject that created the metadata."
- ],
- "enum": [
- "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED",
- "DOCUMENT",
- "PROJECT"
- ],
- "description": "The metadata visibility. Developer metadata must always have a visibility\nspecified.",
- "type": "string"
- }
- },
- "id": "DeveloperMetadata"
- },
- "DuplicateSheetResponse": {
- "description": "The result of duplicating a sheet.",
- "type": "object",
- "properties": {
- "properties": {
- "description": "The properties of the duplicate sheet.",
- "$ref": "SheetProperties"
- }
- },
- "id": "DuplicateSheetResponse"
- },
- "TextToColumnsRequest": {
- "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell.",
- "type": "object",
- "properties": {
- "delimiter": {
- "description": "The delimiter to use. Used only if delimiterType is\nCUSTOM.",
- "type": "string"
- },
- "source": {
- "description": "The source data range. This must span exactly one column.",
- "$ref": "GridRange"
- },
- "delimiterType": {
- "type": "string",
- "enumDescriptions": [
- "Default value. This value must not be used.",
- "\",\"",
- "\";\"",
- "\".\"",
- "\" \"",
- "A custom value as defined in delimiter."
- ],
- "enum": [
- "DELIMITER_TYPE_UNSPECIFIED",
- "COMMA",
- "SEMICOLON",
- "PERIOD",
- "SPACE",
- "CUSTOM"
- ],
- "description": "The delimiter type to use."
- }
- },
- "id": "TextToColumnsRequest"
- },
- "ClearBasicFilterRequest": {
- "properties": {
- "sheetId": {
- "description": "The sheet ID on which the basic filter should be cleared.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ClearBasicFilterRequest",
- "description": "Clears the basic filter, if any exists on the sheet.",
- "type": "object"
- },
- "BatchUpdateSpreadsheetResponse": {
- "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"
- }
- },
- "updatedSpreadsheet": {
- "$ref": "Spreadsheet",
- "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`."
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- }
- },
- "id": "BatchUpdateSpreadsheetResponse",
- "description": "The reply for batch updating a spreadsheet.",
- "type": "object"
- },
- "DeleteBandingRequest": {
- "description": "Removes the banded range with the given ID from the spreadsheet.",
- "type": "object",
- "properties": {
- "bandedRangeId": {
- "description": "The ID of the banded range to delete.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteBandingRequest"
- },
- "AppendValuesResponse": {
- "properties": {
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
- "updates": {
- "$ref": "UpdateValuesResponse",
- "description": "Information about the updates that were applied."
- },
- "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"
- },
- "MoveDimensionRequest": {
- "description": "Moves one or more rows or columns.",
- "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."
- }
- },
- "id": "MoveDimensionRequest"
- },
- "AddFilterViewRequest": {
- "description": "Adds a filter view.",
- "type": "object",
- "properties": {
- "filter": {
- "description": "The filter to add. The filterViewId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a filter that already exists.)",
- "$ref": "FilterView"
- }
- },
- "id": "AddFilterViewRequest"
- },
- "PivotFilterCriteria": {
- "description": "Criteria for showing/hiding rows in a pivot table.",
- "type": "object",
- "properties": {
- "visibleValues": {
- "description": "Values that should be included. Values not listed here are excluded.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "PivotFilterCriteria"
- },
- "AddConditionalFormatRuleRequest": {
- "properties": {
- "index": {
- "description": "The zero-based index where the rule should be inserted.",
- "format": "int32",
- "type": "integer"
- },
- "rule": {
- "$ref": "ConditionalFormatRule",
- "description": "The rule to add."
- }
- },
- "id": "AddConditionalFormatRuleRequest",
- "description": "Adds a new conditional format rule at the given index.\nAll subsequent rules' indexes are incremented.",
- "type": "object"
- },
- "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": {
- "subtitleTextFormat": {
- "$ref": "TextFormat",
- "description": "The subtitle text format.\nStrikethrough and underline are not supported."
- },
- "subtitle": {
- "type": "string",
- "description": "The subtitle of the chart."
- },
- "backgroundColor": {
- "description": "The background color of the entire chart.\nNot applicable to Org charts.",
- "$ref": "Color"
- },
- "subtitleTextPosition": {
- "$ref": "TextPosition",
- "description": "The subtitle text position.\nThis field is optional."
- },
- "basicChart": {
- "description": "A basic chart specification, can be one of many kinds of charts.\nSee BasicChartType for the list of all\ncharts this supports.",
- "$ref": "BasicChartSpec"
- },
- "orgChart": {
- "$ref": "OrgChartSpec",
- "description": "An org chart specification."
- },
- "pieChart": {
- "$ref": "PieChartSpec",
- "description": "A pie chart specification."
- },
- "titleTextFormat": {
- "$ref": "TextFormat",
- "description": "The title text format.\nStrikethrough and underline are not supported."
- },
- "title": {
- "type": "string",
- "description": "The title of the chart."
- },
- "altText": {
- "type": "string",
- "description": "The alternative text that describes the chart. This is often used\nfor accessibility."
- },
- "titleTextPosition": {
- "description": "The title text position.\nThis field is optional.",
- "$ref": "TextPosition"
- },
- "histogramChart": {
- "$ref": "HistogramChartSpec",
- "description": "A histogram chart specification."
- },
- "candlestickChart": {
- "$ref": "CandlestickChartSpec",
- "description": "A candlestick chart specification."
- },
- "bubbleChart": {
- "description": "A bubble chart specification.",
- "$ref": "BubbleChartSpec"
- },
- "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": {
- "type": "boolean",
- "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.)"
- },
- "hiddenDimensionStrategy": {
- "enumDescriptions": [
- "Default value, do not use.",
- "Charts will skip hidden rows and columns.",
- "Charts will skip hidden rows only.",
- "Charts will skip hidden columns only.",
- "Charts will not skip any hidden rows or columns."
- ],
- "enum": [
- "CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED",
- "SKIP_HIDDEN_ROWS_AND_COLUMNS",
- "SKIP_HIDDEN_ROWS",
- "SKIP_HIDDEN_COLUMNS",
- "SHOW_ALL"
- ],
- "description": "Determines how the charts will use hidden rows or columns.",
- "type": "string"
- }
- },
- "id": "ChartSpec"
- },
- "BatchGetValuesByDataFilterResponse": {
- "id": "BatchGetValuesByDataFilterResponse",
- "description": "The response when retrieving more than one range of values in a spreadsheet\nselected by DataFilters.",
- "type": "object",
- "properties": {
- "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"
- }
- }
- },
- "NumberFormat": {
- "description": "The number format of a cell.",
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "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`"
- ],
- "enum": [
- "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."
- },
- "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": "NumberFormat"
- },
- "DataFilterValueRange": {
- "type": "object",
- "properties": {
- "dataFilter": {
- "$ref": "DataFilter",
- "description": "The data filter describing the location of the values in the spreadsheet."
- },
- "majorDimension": {
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The major dimension of the values.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ]
- },
- "values": {
- "description": "The data to be written. If the provided values exceed any of the ranges\nmatched by the data filter then the request will fail. If the provided\nvalues are less than the matched ranges only the specified values will be\nwritten, existing values in the matched ranges will remain unaffected.",
- "type": "array",
- "items": {
- "type": "array",
- "items": {
- "type": "any"
- }
- }
- }
- },
- "id": "DataFilterValueRange",
- "description": "A range of values whose location is specified by a DataFilter."
- },
- "CandlestickDomain": {
- "type": "object",
- "properties": {
- "data": {
- "$ref": "ChartData",
- "description": "The data of the CandlestickDomain."
- },
- "reversed": {
- "description": "True to reverse the order of the domain values (horizontal axis).",
- "type": "boolean"
- }
- },
- "id": "CandlestickDomain",
- "description": "The domain of a CandlestickChart."
- },
- "SheetProperties": {
- "description": "Properties of a sheet.",
- "type": "object",
- "properties": {
- "title": {
- "description": "The name of the sheet.",
- "type": "string"
- },
- "tabColor": {
- "$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.",
- "format": "int32",
- "type": "integer"
- },
- "sheetId": {
- "description": "The ID of the sheet. Must be non-negative.\nThis field cannot be changed once set.",
- "format": "int32",
- "type": "integer"
- },
- "rightToLeft": {
- "description": "True if the sheet is an RTL sheet instead of an LTR sheet.",
- "type": "boolean"
- },
- "hidden": {
- "description": "True if the sheet is hidden in the UI, false if it's visible.",
- "type": "boolean"
- },
- "sheetType": {
- "enumDescriptions": [
- "Default value, do not use.",
- "The sheet is a grid.",
- "The sheet has no grid and instead has an object like a chart or image."
- ],
- "enum": [
- "SHEET_TYPE_UNSPECIFIED",
- "GRID",
- "OBJECT"
- ],
- "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "SheetProperties"
- },
- "UpdateDimensionPropertiesRequest": {
- "description": "Updates properties of dimensions within the specified range.",
- "type": "object",
- "properties": {
- "properties": {
- "description": "Properties to update.",
- "$ref": "DimensionProperties"
- },
- "range": {
- "$ref": "DimensionRange",
- "description": "The rows or columns 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"
- }
- },
- "id": "UpdateDimensionPropertiesRequest"
- },
- "SourceAndDestination": {
- "description": "A combination of a source range and how to extend that source.",
- "type": "object",
- "properties": {
- "fillLength": {
- "description": "The number of rows or columns that data should be filled into.\nPositive numbers expand beyond the last row or last column\nof the source. Negative numbers expand before the first row\nor first column of the source.",
- "format": "int32",
- "type": "integer"
- },
- "source": {
- "$ref": "GridRange",
- "description": "The location of the data to use as the source of the autofill."
- },
- "dimension": {
- "description": "The dimension that data should be filled into.",
- "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"
- ]
- }
- },
- "id": "SourceAndDestination"
+ "id": "DuplicateSheetRequest"
}
},
"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": "Sheets",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/spreadsheets": {
- "description": "View and manage your spreadsheets in Google Drive"
- },
"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"
},
@@ -5433,6 +4646,9 @@
},
"https://www.googleapis.com/auth/spreadsheets.readonly": {
"description": "View your Google Spreadsheets"
+ },
+ "https://www.googleapis.com/auth/spreadsheets": {
+ "description": "View and manage your spreadsheets in Google Drive"
}
}
}
@@ -5442,5 +4658,789 @@
"name": "sheets",
"batchPath": "batch",
"title": "Google Sheets API",
- "ownerName": "Google"
+ "ownerName": "Google",
+ "resources": {
+ "spreadsheets": {
+ "resources": {
+ "sheets": {
+ "methods": {
+ "copyTo": {
+ "description": "Copies a single sheet from a spreadsheet to another spreadsheet.\nReturns the properties of the newly created sheet.",
+ "request": {
+ "$ref": "CopySheetToAnotherSpreadsheetRequest"
+ },
+ "response": {
+ "$ref": "SheetProperties"
+ },
+ "parameterOrder": [
+ "spreadsheetId",
+ "sheetId"
+ ],
+ "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 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"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
+ "path": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
+ "id": "sheets.spreadsheets.sheets.copyTo"
+ }
+ }
+ },
+ "developerMetadata": {
+ "methods": {
+ "search": {
+ "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search",
+ "id": "sheets.spreadsheets.developerMetadata.search",
+ "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.",
+ "request": {
+ "$ref": "SearchDeveloperMetadataRequest"
+ },
+ "response": {
+ "$ref": "SearchDeveloperMetadataResponse"
+ },
+ "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 metadata from.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search"
+ },
+ "get": {
+ "response": {
+ "$ref": "DeveloperMetadata"
+ },
+ "parameterOrder": [
+ "spreadsheetId",
+ "metadataId"
+ ],
+ "httpMethod": "GET",
+ "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 retrieve metadata from.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "metadataId": {
+ "description": "The ID of the developer metadata to retrieve.",
+ "format": "int32",
+ "required": true,
+ "type": "integer",
+ "location": "path"
+ }
+ },
+ "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": {
+ "get": {
+ "response": {
+ "$ref": "ValueRange"
+ },
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "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": {
+ "description": "The ID of the spreadsheet to retrieve data from.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "range": {
+ "location": "path",
+ "description": "The A1 notation of the values to retrieve.",
+ "required": true,
+ "type": "string"
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "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."
+ },
+ "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"
+ },
+ "response": {
+ "$ref": "BatchUpdateValuesByDataFilterResponse"
+ },
+ "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 update.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter",
+ "id": "sheets.spreadsheets.values.batchUpdateByDataFilter"
+ },
+ "update": {
+ "response": {
+ "$ref": "UpdateValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "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": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string"
+ },
+ "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",
+ "location": "query"
+ },
+ "valueInputOption": {
+ "location": "query",
+ "enum": [
+ "INPUT_VALUE_OPTION_UNSPECIFIED",
+ "RAW",
+ "USER_ENTERED"
+ ],
+ "description": "How the input data should be interpreted.",
+ "type": "string"
+ },
+ "responseDateTimeRenderOption": {
+ "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].",
+ "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/{range}",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "id": "sheets.spreadsheets.values.update",
+ "request": {
+ "$ref": "ValueRange"
+ },
+ "description": "Sets values in a range of a spreadsheet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption."
+ },
+ "batchUpdate": {
+ "response": {
+ "$ref": "BatchUpdateValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "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: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."
+ },
+ "batchGet": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "response": {
+ "$ref": "BatchGetValuesResponse"
+ },
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to retrieve data from.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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": {
+ "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"
+ },
+ "ranges": {
+ "repeated": true,
+ "location": "query",
+ "description": "The A1 notation of the values to retrieve.",
+ "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"
+ }
+ },
+ "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"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values: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."
+ },
+ "clear": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "response": {
+ "$ref": "ClearValuesResponse"
+ },
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "range": {
+ "description": "The A1 notation of the values to clear.",
+ "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/{range}:clear",
+ "id": "sheets.spreadsheets.values.clear",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}: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."
+ },
+ "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"
+ },
+ "response": {
+ "$ref": "BatchClearValuesByDataFilterResponse"
+ },
+ "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.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter"
+ },
+ "append": {
+ "response": {
+ "$ref": "AppendValuesResponse"
+ },
+ "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"
+ ],
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "responseValueRenderOption": {
+ "location": "query",
+ "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"
+ },
+ "insertDataOption": {
+ "location": "query",
+ "enum": [
+ "OVERWRITE",
+ "INSERT_ROWS"
+ ],
+ "description": "How the input data should be inserted.",
+ "type": "string"
+ },
+ "valueInputOption": {
+ "enum": [
+ "INPUT_VALUE_OPTION_UNSPECIFIED",
+ "RAW",
+ "USER_ENTERED"
+ ],
+ "description": "How the input data should be interpreted.",
+ "type": "string",
+ "location": "query"
+ },
+ "responseDateTimeRenderOption": {
+ "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].",
+ "type": "string"
+ },
+ "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"
+ },
+ "includeValuesInResponse": {
+ "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",
+ "location": "query"
+ }
+ },
+ "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"
+ }
+ },
+ "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"
+ },
+ "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"
+ },
+ "batchClear": {
+ "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.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "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"
+ }
+ }
+ }
+ }
+ },
+ "methods": {
+ "get": {
+ "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.",
+ "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": {
+ "description": "The spreadsheet to request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "ranges": {
+ "description": "The ranges to retrieve from the spreadsheet.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "includeGridData": {
+ "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}"
+ },
+ "getByDataFilter": {
+ "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",
+ "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"
+ }
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Spreadsheet"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.file",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets",
+ "id": "sheets.spreadsheets.create",
+ "path": "v4/spreadsheets",
+ "request": {
+ "$ref": "Spreadsheet"
+ },
+ "description": "Creates a spreadsheet, returning the newly created spreadsheet."
+ },
+ "batchUpdate": {
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "response": {
+ "$ref": "BatchUpdateSpreadsheetResponse"
+ },
+ "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"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
+ "id": "sheets.spreadsheets.batchUpdate",
+ "path": "v4/spreadsheets/{spreadsheetId}:batchUpdate"
+ }
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "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",
+ "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"
+ }
+ },
+ "version": "v4",
+ "baseUrl": "https://sheets.googleapis.com/"
}
diff --git a/slides/v1/slides-api.json b/slides/v1/slides-api.json
index b883301..91ff644 100644
--- a/slides/v1/slides-api.json
+++ b/slides/v1/slides-api.json
@@ -1,76 +1,1223 @@
{
"schemas": {
- "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.",
+ "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 with the text to be styled.",
+ "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 containing the paragraph(s) to style."
+ "description": "The range of text to apply the bullet presets to, based on TextElement indexes."
+ },
+ "bulletPreset": {
+ "type": "string",
+ "enumDescriptions": [
+ "A bulleted list with a `DISC`, `CIRCLE` and `SQUARE` bullet glyph for the\nfirst 3 list nesting levels.",
+ "A bulleted list with a `DIAMONDX`, `ARROW3D` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
+ "A bulleted list with `CHECKBOX` bullet glyphs for all list nesting levels.",
+ "A bulleted list with a `ARROW`, `DIAMOND` and `DISC` bullet glyph for\nthe first 3 list nesting levels.",
+ "A bulleted list with a `STAR`, `CIRCLE` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
+ "A bulleted list with a `ARROW3D`, `CIRCLE` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
+ "A bulleted list with a `LEFTTRIANGLE`, `DIAMOND` and `DISC` bullet glyph\nfor the first 3 list nesting levels.",
+ "A bulleted list with a `DIAMONDX`, `HOLLOWDIAMOND` and `SQUARE` bullet\nglyph for the first 3 list nesting levels.",
+ "A bulleted list with a `DIAMOND`, `CIRCLE` and `SQUARE` bullet glyph\nfor the first 3 list nesting levels.",
+ "A numbered list with `DIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods.",
+ "A numbered list with `DIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by parenthesis.",
+ "A numbered list with `DIGIT` numeric glyphs separated by periods, where\neach nesting level uses the previous nesting level's glyph as a prefix.\nFor example: '1.', '1.1.', '2.', '2.2.'.",
+ "A numbered list with `UPPERALPHA`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods.",
+ "A numbered list with `UPPERROMAN`, `UPPERALPHA` and `DIGIT` numeric glyphs\nfor the first 3 list nesting levels, followed by periods.",
+ "A numbered list with `ZERODIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods."
+ ],
+ "enum": [
+ "BULLET_DISC_CIRCLE_SQUARE",
+ "BULLET_DIAMONDX_ARROW3D_SQUARE",
+ "BULLET_CHECKBOX",
+ "BULLET_ARROW_DIAMOND_DISC",
+ "BULLET_STAR_CIRCLE_SQUARE",
+ "BULLET_ARROW3D_CIRCLE_SQUARE",
+ "BULLET_LEFTTRIANGLE_DIAMOND_DISC",
+ "BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE",
+ "BULLET_DIAMOND_CIRCLE_SQUARE",
+ "NUMBERED_DIGIT_ALPHA_ROMAN",
+ "NUMBERED_DIGIT_ALPHA_ROMAN_PARENS",
+ "NUMBERED_DIGIT_NESTED",
+ "NUMBERED_UPPERALPHA_ALPHA_ROMAN",
+ "NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT",
+ "NUMBERED_ZERODIGIT_ALPHA_ROMAN"
+ ],
+ "description": "The kinds of bullet glyphs to be used. Defaults to the\n`BULLET_DISC_CIRCLE_SQUARE` preset."
},
"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": {
- "type": "string",
- "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"
+ "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."
}
},
- "id": "UpdateParagraphStyleRequest"
+ "id": "CreateParagraphBulletsRequest"
},
- "ColorScheme": {
- "description": "The palette of predefined colors for a page.",
+ "Size": {
+ "description": "A width and height.",
"type": "object",
"properties": {
- "colors": {
- "description": "The ThemeColorType and corresponding concrete color pairs.",
+ "width": {
+ "$ref": "Dimension",
+ "description": "The width of the object."
+ },
+ "height": {
+ "$ref": "Dimension",
+ "description": "The height of the object."
+ }
+ },
+ "id": "Size"
+ },
+ "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": {
+ "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"
+ },
+ "italic": {
+ "type": "boolean",
+ "description": "Whether or not the text is italicized."
+ },
+ "strikethrough": {
+ "type": "boolean",
+ "description": "Whether or not the text is struck through."
+ },
+ "fontSize": {
+ "$ref": "Dimension",
+ "description": "The size of the text's font. When read, the `font_size` will specified in\npoints."
+ },
+ "baselineOffset": {
+ "type": "string",
+ "enumDescriptions": [
+ "The text's baseline offset is inherited from the parent.",
+ "The text is not vertically offset.",
+ "The text is vertically offset upwards (superscript).",
+ "The text is vertically offset downwards (subscript)."
+ ],
+ "enum": [
+ "BASELINE_OFFSET_UNSPECIFIED",
+ "NONE",
+ "SUPERSCRIPT",
+ "SUBSCRIPT"
+ ],
+ "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."
+ },
+ "weightedFontFamily": {
+ "$ref": "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."
+ },
+ "smallCaps": {
+ "description": "Whether or not the text is in small capital letters.",
+ "type": "boolean"
+ },
+ "backgroundColor": {
+ "$ref": "OptionalColor",
+ "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."
+ },
+ "underline": {
+ "type": "boolean",
+ "description": "Whether or not the text is underlined."
+ },
+ "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": {
+ "type": "boolean",
+ "description": "Whether or not the text is rendered as bold."
+ },
+ "foregroundColor": {
+ "$ref": "OptionalColor",
+ "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."
+ }
+ },
+ "id": "TextStyle"
+ },
+ "UpdateVideoPropertiesRequest": {
+ "type": "object",
+ "properties": {
+ "fields": {
+ "type": "string",
+ "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"
+ },
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the video the updates are applied to."
+ },
+ "videoProperties": {
+ "$ref": "VideoProperties",
+ "description": "The video properties to update."
+ }
+ },
+ "id": "UpdateVideoPropertiesRequest",
+ "description": "Update the properties of a Video."
+ },
+ "Request": {
+ "type": "object",
+ "properties": {
+ "deleteTableColumn": {
+ "$ref": "DeleteTableColumnRequest",
+ "description": "Deletes a column from a table."
+ },
+ "duplicateObject": {
+ "$ref": "DuplicateObjectRequest",
+ "description": "Duplicates a slide or page element."
+ },
+ "createLine": {
+ "$ref": "CreateLineRequest",
+ "description": "Creates a line."
+ },
+ "updateVideoProperties": {
+ "$ref": "UpdateVideoPropertiesRequest",
+ "description": "Updates the properties of a Video."
+ },
+ "createImage": {
+ "$ref": "CreateImageRequest",
+ "description": "Creates an image."
+ },
+ "createParagraphBullets": {
+ "$ref": "CreateParagraphBulletsRequest",
+ "description": "Creates bullets for paragraphs."
+ },
+ "createVideo": {
+ "$ref": "CreateVideoRequest",
+ "description": "Creates a video."
+ },
+ "createSheetsChart": {
+ "$ref": "CreateSheetsChartRequest",
+ "description": "Creates an embedded Google Sheets chart."
+ },
+ "replaceAllShapesWithSheetsChart": {
+ "$ref": "ReplaceAllShapesWithSheetsChartRequest",
+ "description": "Replaces all shapes matching some criteria with a Google Sheets chart."
+ },
+ "unmergeTableCells": {
+ "$ref": "UnmergeTableCellsRequest",
+ "description": "Unmerges cells in a Table."
+ },
+ "updatePageElementTransform": {
+ "$ref": "UpdatePageElementTransformRequest",
+ "description": "Updates the transform of a page element."
+ },
+ "updateTextStyle": {
+ "$ref": "UpdateTextStyleRequest",
+ "description": "Updates the styling of text within a Shape or Table."
+ },
+ "updateTableRowProperties": {
+ "$ref": "UpdateTableRowPropertiesRequest",
+ "description": "Updates the properties of a Table row."
+ },
+ "replaceAllShapesWithImage": {
+ "$ref": "ReplaceAllShapesWithImageRequest",
+ "description": "Replaces all shapes matching some criteria with an image."
+ },
+ "replaceAllText": {
+ "$ref": "ReplaceAllTextRequest",
+ "description": "Replaces all instances of specified text."
+ },
+ "updateImageProperties": {
+ "$ref": "UpdateImagePropertiesRequest",
+ "description": "Updates the properties of an Image."
+ },
+ "createSlide": {
+ "$ref": "CreateSlideRequest",
+ "description": "Creates a new slide."
+ },
+ "insertTableRows": {
+ "$ref": "InsertTableRowsRequest",
+ "description": "Inserts rows into a table."
+ },
+ "updateLineProperties": {
+ "$ref": "UpdateLinePropertiesRequest",
+ "description": "Updates the properties of a Line."
+ },
+ "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": {
+ "$ref": "UpdateShapePropertiesRequest",
+ "description": "Updates the properties of a Shape."
+ },
+ "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": {
+ "$ref": "UpdateTableColumnPropertiesRequest",
+ "description": "Updates the properties of a Table\ncolumn."
+ },
+ "deleteText": {
+ "$ref": "DeleteTextRequest",
+ "description": "Deletes text from a shape or a table cell."
+ },
+ "updatePageProperties": {
+ "$ref": "UpdatePagePropertiesRequest",
+ "description": "Updates the properties of a Page."
+ },
+ "createShape": {
+ "$ref": "CreateShapeRequest",
+ "description": "Creates a new shape."
+ },
+ "deleteParagraphBullets": {
+ "$ref": "DeleteParagraphBulletsRequest",
+ "description": "Deletes bullets from paragraphs."
+ },
+ "updateTableBorderProperties": {
+ "$ref": "UpdateTableBorderPropertiesRequest",
+ "description": "Updates the properties of the table borders in a Table."
+ },
+ "insertTableColumns": {
+ "$ref": "InsertTableColumnsRequest",
+ "description": "Inserts columns into a table."
+ },
+ "mergeTableCells": {
+ "$ref": "MergeTableCellsRequest",
+ "description": "Merges cells in a Table."
+ },
+ "refreshSheetsChart": {
+ "$ref": "RefreshSheetsChartRequest",
+ "description": "Refreshes a Google Sheets chart."
+ },
+ "updateTableCellProperties": {
+ "$ref": "UpdateTableCellPropertiesRequest",
+ "description": "Updates the properties of a TableCell."
+ },
+ "createTable": {
+ "$ref": "CreateTableRequest",
+ "description": "Creates a new table."
+ },
+ "deleteObject": {
+ "$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."
+ }
+ },
+ "id": "Request",
+ "description": "A single kind of update to apply to a presentation."
+ },
+ "UpdateImagePropertiesRequest": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the image the updates are applied to."
+ },
+ "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": {
+ "$ref": "ImageProperties",
+ "description": "The image properties to update."
+ }
+ },
+ "id": "UpdateImagePropertiesRequest",
+ "description": "Update the properties of an Image."
+ },
+ "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": {
+ "spaceBelow": {
+ "$ref": "Dimension",
+ "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent."
+ },
+ "direction": {
+ "enum": [
+ "TEXT_DIRECTION_UNSPECIFIED",
+ "LEFT_TO_RIGHT",
+ "RIGHT_TO_LEFT"
+ ],
+ "description": "The text direction of this paragraph. If unset, the value defaults to\nLEFT_TO_RIGHT since\ntext direction is not inherited.",
+ "type": "string",
+ "enumDescriptions": [
+ "The text direction is inherited from the parent.",
+ "The text goes from left to right.",
+ "The text goes from right to left."
+ ]
+ },
+ "spacingMode": {
+ "enum": [
+ "SPACING_MODE_UNSPECIFIED",
+ "NEVER_COLLAPSE",
+ "COLLAPSE_LISTS"
+ ],
+ "description": "The spacing mode for the paragraph.",
+ "type": "string",
+ "enumDescriptions": [
+ "The spacing mode is inherited from the parent.",
+ "Paragraph spacing is always rendered.",
+ "Paragraph spacing is skipped between list elements."
+ ]
+ },
+ "indentEnd": {
+ "$ref": "Dimension",
+ "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."
+ },
+ "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."
+ },
+ "alignment": {
+ "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.",
+ "The paragraph is centered.",
+ "The paragraph is aligned to the end of the line. Right-aligned for\nLTR text, left-aligned otherwise.",
+ "The paragraph is justified."
+ ],
+ "enum": [
+ "ALIGNMENT_UNSPECIFIED",
+ "START",
+ "CENTER",
+ "END",
+ "JUSTIFIED"
+ ],
+ "description": "The text alignment for this paragraph."
+ },
+ "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."
+ }
+ },
+ "id": "ParagraphStyle"
+ },
+ "UpdateTableRowPropertiesRequest": {
+ "description": "Updates the properties of a Table row.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "type": "string",
+ "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"
+ },
+ "tableRowProperties": {
+ "$ref": "TableRowProperties",
+ "description": "The table row properties to update."
+ },
+ "objectId": {
+ "description": "The object ID of the table.",
+ "type": "string"
+ },
+ "rowIndices": {
"type": "array",
"items": {
- "$ref": "ThemeColorPair"
+ "format": "int32",
+ "type": "integer"
+ },
+ "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."
+ }
+ },
+ "id": "UpdateTableRowPropertiesRequest"
+ },
+ "ReplaceAllShapesWithSheetsChartResponse": {
+ "type": "object",
+ "properties": {
+ "occurrencesChanged": {
+ "description": "The number of shapes replaced with charts.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ReplaceAllShapesWithSheetsChartResponse",
+ "description": "The result of replacing shapes with a Google Sheets chart."
+ },
+ "TableCellProperties": {
+ "description": "The properties of the TableCell.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "enum": [
+ "CONTENT_ALIGNMENT_UNSPECIFIED",
+ "CONTENT_ALIGNMENT_UNSUPPORTED",
+ "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",
+ "enumDescriptions": [
+ "An unspecified content alignment. The content alignment is inherited from\nthe parent if it exists.",
+ "An unsupported content alignment.",
+ "An alignment that aligns the content to the top of the content holder.\nCorresponds to ECMA-376 ST_TextAnchoringType 't'.",
+ "An alignment that aligns the content to the middle of the content\nholder. Corresponds to ECMA-376 ST_TextAnchoringType 'ctr'.",
+ "An alignment that aligns the content to the bottom of the content\nholder. Corresponds to ECMA-376 ST_TextAnchoringType 'b'."
+ ]
+ }
+ },
+ "id": "TableCellProperties"
+ },
+ "Outline": {
+ "type": "object",
+ "properties": {
+ "outlineFill": {
+ "$ref": "OutlineFill",
+ "description": "The fill of the outline."
+ },
+ "weight": {
+ "$ref": "Dimension",
+ "description": "The thickness of the outline."
+ },
+ "dashStyle": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified dash style.",
+ "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
+ "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
+ "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
+ "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
+ "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
+ "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
+ ],
+ "enum": [
+ "DASH_STYLE_UNSPECIFIED",
+ "SOLID",
+ "DOT",
+ "DASH",
+ "DASH_DOT",
+ "LONG_DASH",
+ "LONG_DASH_DOT"
+ ],
+ "description": "The dash style of the outline."
+ },
+ "propertyState": {
+ "enum": [
+ "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",
+ "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."
+ ]
+ }
+ },
+ "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."
+ },
+ "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": {
+ "objectId": {
+ "description": "The object ID of the chart to refresh.",
+ "type": "string"
+ }
+ },
+ "id": "RefreshSheetsChartRequest"
+ },
+ "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": {
+ "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": {
+ "$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": {
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified content alignment. The content alignment is inherited from\nthe parent if it exists.",
+ "An unsupported content alignment.",
+ "An alignment that aligns the content to the top of the content holder.\nCorresponds to ECMA-376 ST_TextAnchoringType 't'.",
+ "An alignment that aligns the content to the middle of the content\nholder. Corresponds to ECMA-376 ST_TextAnchoringType 'ctr'.",
+ "An alignment that aligns the content to the bottom of the content\nholder. Corresponds to ECMA-376 ST_TextAnchoringType 'b'."
+ ],
+ "enum": [
+ "CONTENT_ALIGNMENT_UNSPECIFIED",
+ "CONTENT_ALIGNMENT_UNSUPPORTED",
+ "TOP",
+ "MIDDLE",
+ "BOTTOM"
+ ],
+ "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."
+ },
+ "link": {
+ "$ref": "Link",
+ "description": "The hyperlink destination of the shape. If unset, there is no link. Links\nare not inherited from parent placeholders."
+ },
+ "outline": {
+ "$ref": "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."
+ }
+ },
+ "id": "ShapeProperties"
+ },
+ "TableColumnProperties": {
+ "type": "object",
+ "properties": {
+ "columnWidth": {
+ "$ref": "Dimension",
+ "description": "Width of a column."
+ }
+ },
+ "id": "TableColumnProperties",
+ "description": "Properties of each column in a table."
+ },
+ "NotesProperties": {
+ "type": "object",
+ "properties": {
+ "speakerNotesObjectId": {
+ "description": "The object ID of the shape on this notes page that contains the speaker\nnotes for the corresponding slide.\nThe actual shape may not always exist on the notes page. Inserting text\nusing this object ID will automatically create the shape. In this case, the\nactual shape may have different object ID. The `GetPresentation` or\n`GetPage` action will always return the latest object ID.",
+ "type": "string"
+ }
+ },
+ "id": "NotesProperties",
+ "description": "The properties of Page that are only\nrelevant for pages with page_type NOTES."
+ },
+ "TableRow": {
+ "type": "object",
+ "properties": {
+ "tableRowProperties": {
+ "$ref": "TableRowProperties",
+ "description": "Properties of the row."
+ },
+ "rowHeight": {
+ "$ref": "Dimension",
+ "description": "Height of a row."
+ },
+ "tableCells": {
+ "type": "array",
+ "items": {
+ "$ref": "TableCell"
+ },
+ "description": "Properties and contents of each cell.\n\nCells that span multiple columns are represented only once with a\ncolumn_span greater\nthan 1. As a result, the length of this collection does not always match\nthe number of columns of the entire table."
+ }
+ },
+ "id": "TableRow",
+ "description": "Properties and contents of each row in a table."
+ },
+ "UpdateTableCellPropertiesRequest": {
+ "description": "Update the properties of a TableCell.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "type": "string",
+ "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"
+ },
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the table."
+ },
+ "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."
+ },
+ "tableCellProperties": {
+ "$ref": "TableCellProperties",
+ "description": "The table cell properties to update."
+ }
+ },
+ "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`."
+ },
+ "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"
+ },
+ "insertionIndex": {
+ "description": "The optional zero-based index indicating where to insert the slides.\n\nIf you don't specify an index, the new slide is created at the end.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "placeholderIdMappings": {
+ "description": "An optional list of object ID mappings from the placeholder(s) on the layout to the placeholder(s)\nthat will be created on the new slide from that specified layout. Can only\nbe used when `slide_layout_reference` is specified.",
+ "type": "array",
+ "items": {
+ "$ref": "LayoutPlaceholderIdMapping"
}
}
},
- "id": "ColorScheme"
+ "id": "CreateSlideRequest"
},
- "Shape": {
- "id": "Shape",
- "description": "A PageElement kind representing a\ngeneric shape that does not have a more specific classification.",
+ "TableRowProperties": {
"type": "object",
"properties": {
+ "minRowHeight": {
+ "$ref": "Dimension",
+ "description": "Minimum height of the row. The row will be rendered in the Slides editor at\na height equal to or greater than this value in order to show all the text\nin the row's cell(s)."
+ }
+ },
+ "id": "TableRowProperties",
+ "description": "Properties of each row in a table."
+ },
+ "BatchUpdatePresentationRequest": {
+ "description": "Request message for PresentationsService.BatchUpdatePresentation.",
+ "type": "object",
+ "properties": {
+ "requests": {
+ "type": "array",
+ "items": {
+ "$ref": "Request"
+ },
+ "description": "A list of updates to apply to the presentation."
+ },
+ "writeControl": {
+ "$ref": "WriteControl",
+ "description": "Provides control over how write requests are executed."
+ }
+ },
+ "id": "BatchUpdatePresentationRequest"
+ },
+ "GroupObjectsResponse": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the created group."
+ }
+ },
+ "id": "GroupObjectsResponse",
+ "description": "The result of grouping objects."
+ },
+ "TextContent": {
+ "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": {
+ "textElements": {
+ "type": "array",
+ "items": {
+ "$ref": "TextElement"
+ },
+ "description": "The text contents broken down into its component parts, including styling\ninformation. This property is read-only."
+ },
+ "lists": {
+ "additionalProperties": {
+ "$ref": "List"
+ },
+ "description": "The bulleted lists contained in this text, keyed by list ID.",
+ "type": "object"
+ }
+ },
+ "id": "TextContent"
+ },
+ "TableBorderCell": {
+ "type": "object",
+ "properties": {
+ "tableBorderProperties": {
+ "$ref": "TableBorderProperties",
+ "description": "The border properties."
+ },
+ "location": {
+ "$ref": "TableCellLocation",
+ "description": "The location of the border within the border table."
+ }
+ },
+ "id": "TableBorderCell",
+ "description": "The properties of each border cell."
+ },
+ "TableBorderProperties": {
+ "description": "The border styling properties of the\nTableBorderCell.",
+ "type": "object",
+ "properties": {
+ "weight": {
+ "$ref": "Dimension",
+ "description": "The thickness of the border."
+ },
+ "tableBorderFill": {
+ "$ref": "TableBorderFill",
+ "description": "The fill of the table border."
+ },
+ "dashStyle": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified dash style.",
+ "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
+ "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
+ "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
+ "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
+ "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
+ "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
+ ],
+ "enum": [
+ "DASH_STYLE_UNSPECIFIED",
+ "SOLID",
+ "DOT",
+ "DASH",
+ "DASH_DOT",
+ "LONG_DASH",
+ "LONG_DASH_DOT"
+ ],
+ "description": "The dash style of the border."
+ }
+ },
+ "id": "TableBorderProperties"
+ },
+ "CreateSheetsChartResponse": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the created chart."
+ }
+ },
+ "id": "CreateSheetsChartResponse",
+ "description": "The result of creating an embedded Google Sheets chart."
+ },
+ "WriteControl": {
+ "type": "object",
+ "properties": {
+ "requiredRevisionId": {
+ "type": "string",
+ "description": "The revision ID of the presentation required for the write request. If\nspecified and the `required_revision_id` doesn't exactly match the\npresentation's current `revision_id`, the request will not be processed and\nwill return a 400 bad request error."
+ }
+ },
+ "id": "WriteControl",
+ "description": "Provides control over how write requests are executed."
+ },
+ "DeleteParagraphBulletsRequest": {
+ "description": "Deletes bullets from all of the paragraphs that overlap with the given text\nindex range.\n\nThe nesting level of each paragraph will be visually preserved by adding\nindent to the start of the corresponding paragraph.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the shape or table containing the text to delete bullets\nfrom.",
+ "type": "string"
+ },
+ "textRange": {
+ "$ref": "Range",
+ "description": "The range of text to delete bullets from, based on TextElement indexes."
+ },
+ "cellLocation": {
+ "$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."
+ }
+ },
+ "id": "DeleteParagraphBulletsRequest"
+ },
+ "ParagraphMarker": {
+ "type": "object",
+ "properties": {
+ "style": {
+ "$ref": "ParagraphStyle",
+ "description": "The paragraph's style"
+ },
+ "bullet": {
+ "$ref": "Bullet",
+ "description": "The bullet for this paragraph. If not present, the paragraph does not\nbelong to a list."
+ }
+ },
+ "id": "ParagraphMarker",
+ "description": "A TextElement kind that represents the beginning of a new paragraph."
+ },
+ "Thumbnail": {
+ "type": "object",
+ "properties": {
+ "contentUrl": {
+ "type": "string",
+ "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`."
+ },
+ "width": {
+ "type": "integer",
+ "description": "The positive width in pixels of the thumbnail image.",
+ "format": "int32"
+ },
+ "height": {
+ "description": "The positive height in pixels of the thumbnail image.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Thumbnail",
+ "description": "The thumbnail of a page."
+ },
+ "InsertTableColumnsRequest": {
+ "description": "Inserts columns into a table.\n\nOther columns in the table will be resized to fit the new column.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "type": "integer",
+ "description": "The number of columns to be inserted. Maximum 20 per request.",
+ "format": "int32"
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The reference table cell location from which columns will be inserted.\n\nA new column will be inserted to the left (or right) of the column where\nthe reference cell is. If the reference cell is a merged cell, a new\ncolumn will be inserted to the left (or right) of the merged cell."
+ },
+ "insertRight": {
+ "type": "boolean",
+ "description": "Whether to insert new columns to the right of the reference cell location.\n\n- `True`: insert to the right.\n- `False`: insert to the left."
+ },
+ "tableObjectId": {
+ "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.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "A user-supplied object ID for the placeholder identified above that to be\ncreated onto a slide.\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."
+ },
+ "layoutPlaceholder": {
+ "$ref": "Placeholder",
+ "description": "The placeholder on a layout that will be applied to a slide. Only type and index are needed. For example, a\npredefined `TITLE_AND_BODY` layout may usually have a TITLE placeholder\nwith index 0 and a BODY placeholder with index 0."
+ },
+ "layoutPlaceholderObjectId": {
+ "type": "string",
+ "description": "The object ID of the placeholder on a layout that will be applied\nto a slide."
+ }
+ },
+ "id": "LayoutPlaceholderIdMapping"
+ },
+ "UpdateTableBorderPropertiesRequest": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the table."
+ },
+ "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": {
+ "$ref": "TableBorderProperties",
+ "description": "The table border properties to update."
+ },
+ "borderPosition": {
+ "type": "string",
+ "enumDescriptions": [
+ "All borders in the range.",
+ "Borders at the bottom of the range.",
+ "Borders on the inside of the range.",
+ "Horizontal borders on the inside of the range.",
+ "Vertical borders on the inside of the range.",
+ "Borders at the left of the range.",
+ "Borders along the outside of the range.",
+ "Borders at the right of the range.",
+ "Borders at the top of the range."
+ ],
+ "enum": [
+ "ALL",
+ "BOTTOM",
+ "INNER",
+ "INNER_HORIZONTAL",
+ "INNER_VERTICAL",
+ "LEFT",
+ "OUTER",
+ "RIGHT",
+ "TOP"
+ ],
+ "description": "The border position in the table range the updates should apply to. If a\nborder position is not specified, the updates will apply to all borders in\nthe table range."
+ },
+ "fields": {
+ "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"
+ }
+ },
+ "id": "UpdateTableBorderPropertiesRequest",
+ "description": "Updates the properties of the table borders in a Table."
+ },
+ "UpdateShapePropertiesRequest": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the shape the updates are applied to.",
+ "type": "string"
+ },
+ "shapeProperties": {
+ "$ref": "ShapeProperties",
+ "description": "The shape properties to update."
+ },
+ "fields": {
+ "type": "string",
+ "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"
+ }
+ },
+ "id": "UpdateShapePropertiesRequest",
+ "description": "Update the properties of a Shape."
+ },
+ "UpdateTableColumnPropertiesRequest": {
+ "description": "Updates the properties of a Table column.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "type": "string",
+ "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"
+ },
+ "objectId": {
+ "description": "The object ID of the table.",
+ "type": "string"
+ },
+ "columnIndices": {
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "description": "The list of zero-based indices specifying which columns to update. If no\nindices are provided, all columns in the table will be updated."
+ },
+ "tableColumnProperties": {
+ "$ref": "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."
+ }
+ },
+ "id": "UpdateTableColumnPropertiesRequest"
+ },
+ "WordArt": {
+ "type": "object",
+ "properties": {
+ "renderedText": {
+ "type": "string",
+ "description": "The text rendered as word art."
+ }
+ },
+ "id": "WordArt",
+ "description": "A PageElement kind representing\nword art."
+ },
+ "Recolor": {
+ "type": "object",
+ "properties": {
+ "recolorStops": {
+ "description": "The recolor effect is represented by a gradient, which is a list of color\nstops.\n\nThe colors in the gradient will replace the corresponding colors at\nthe same position in the color palette and apply to the image. This\nproperty is read-only.",
+ "type": "array",
+ "items": {
+ "$ref": "ColorStop"
+ }
+ },
+ "name": {
+ "enum": [
+ "NONE",
+ "LIGHT1",
+ "LIGHT2",
+ "LIGHT3",
+ "LIGHT4",
+ "LIGHT5",
+ "LIGHT6",
+ "LIGHT7",
+ "LIGHT8",
+ "LIGHT9",
+ "LIGHT10",
+ "DARK1",
+ "DARK2",
+ "DARK3",
+ "DARK4",
+ "DARK5",
+ "DARK6",
+ "DARK7",
+ "DARK8",
+ "DARK9",
+ "DARK10",
+ "GRAYSCALE",
+ "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",
+ "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.",
+ "A recolor effect that lightens the image using the page's second\navailable color from its color scheme.",
+ "A recolor effect that lightens the image using the page's third available\ncolor from its color scheme.",
+ "A recolor effect that lightens the image using the page's forth available\ncolor from its color scheme.",
+ "A recolor effect that lightens the image using the page's fifth available\ncolor from its color scheme.",
+ "A recolor effect that lightens the image using the page's sixth available\ncolor from its color scheme.",
+ "A recolor effect that lightens the image using the page's seventh\navailable color from its color scheme.e.",
+ "A recolor effect that lightens the image using the page's eighth\navailable color from its color scheme.",
+ "A recolor effect that lightens the image using the page's ninth available\ncolor from its color scheme.",
+ "A recolor effect that lightens the image using the page's tenth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's first available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's second available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's third available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's fourth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's fifth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's sixth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's seventh\navailable color from its color scheme.",
+ "A recolor effect that darkens the image using the page's eighth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's ninth available\ncolor from its color scheme.",
+ "A recolor effect that darkens the image using the page's tenth available\ncolor from its color scheme.",
+ "A recolor effect that recolors the image to grayscale.",
+ "A recolor effect that recolors the image to negative grayscale.",
+ "A recolor effect that recolors the image using the sepia color.",
+ "Custom recolor effect. Refer to `recolor_stops` for the concrete\ngradient."
+ ]
+ }
+ },
+ "id": "Recolor",
+ "description": "A recolor effect applied on an image."
+ },
+ "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": {
+ "type": "string",
+ "description": "If set, indicates this is a link to the external web page at this URL."
+ },
+ "relativeLink": {
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified relative slide link.",
+ "A link to the next slide.",
+ "A link to the previous slide.",
+ "A link to the first slide in the presentation.",
+ "A link to the last slide in the presentation."
+ ],
+ "enum": [
+ "RELATIVE_SLIDE_LINK_UNSPECIFIED",
+ "NEXT_SLIDE",
+ "PREVIOUS_SLIDE",
+ "FIRST_SLIDE",
+ "LAST_SLIDE"
+ ],
+ "description": "If set, indicates this is a link to a slide in this presentation,\naddressed by its position."
+ },
+ "slideIndex": {
+ "type": "integer",
+ "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"
+ }
+ },
+ "id": "Link"
+ },
+ "CreateShapeResponse": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created shape.",
+ "type": "string"
+ }
+ },
+ "id": "CreateShapeResponse",
+ "description": "The result of creating a shape."
+ },
+ "RgbColor": {
+ "type": "object",
+ "properties": {
+ "red": {
+ "description": "The red component of the color, from 0.0 to 1.0.",
+ "format": "float",
+ "type": "number"
+ },
+ "green": {
+ "description": "The green component of the color, from 0.0 to 1.0.",
+ "format": "float",
+ "type": "number"
+ },
+ "blue": {
+ "type": "number",
+ "description": "The blue component of the color, from 0.0 to 1.0.",
+ "format": "float"
+ }
+ },
+ "id": "RgbColor",
+ "description": "An RGB color."
+ },
+ "CreateLineRequest": {
+ "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": {
+ "enum": [
+ "STRAIGHT",
+ "BENT",
+ "CURVED"
+ ],
+ "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.",
+ "Curved connectors, including curved connector 2 to 5."
+ ]
+ }
+ },
+ "id": "CreateLineRequest",
+ "description": "Creates a line."
+ },
+ "CreateSlideResponse": {
+ "description": "The result of creating a slide.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created slide.",
+ "type": "string"
+ }
+ },
+ "id": "CreateSlideResponse"
+ },
+ "CreateShapeRequest": {
+ "description": "Creates a new shape.",
+ "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.\nIf empty, a unique identifier will be generated.",
+ "type": "string"
+ },
"shapeType": {
+ "type": "string",
"enumDescriptions": [
"The shape type that is not predefined.",
"Text box shape.",
@@ -361,2686 +1508,1002 @@
"CLOUD_CALLOUT",
"CUSTOM"
],
+ "description": "The shape type."
+ },
+ "elementProperties": {
+ "$ref": "PageElementProperties",
+ "description": "The element properties for the shape."
+ }
+ },
+ "id": "CreateShapeRequest"
+ },
+ "Video": {
+ "type": "object",
+ "properties": {
+ "source": {
+ "type": "string",
+ "enumDescriptions": [
+ "The video source is unspecified.",
+ "The video source is YouTube."
+ ],
+ "enum": [
+ "SOURCE_UNSPECIFIED",
+ "YOUTUBE"
+ ],
+ "description": "The video source."
+ },
+ "url": {
+ "description": "An URL to a video. The URL is valid as long as the source video\nexists and sharing settings do not change.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The video source's unique identifier for this video.",
+ "type": "string"
+ },
+ "videoProperties": {
+ "$ref": "VideoProperties",
+ "description": "The properties of the video."
+ }
+ },
+ "id": "Video",
+ "description": "A PageElement kind representing a\nvideo."
+ },
+ "PageProperties": {
+ "type": "object",
+ "properties": {
+ "pageBackgroundFill": {
+ "$ref": "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."
+ },
+ "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",
+ "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."
+ },
+ "NestingLevel": {
+ "type": "object",
+ "properties": {
+ "bulletStyle": {
+ "$ref": "TextStyle",
+ "description": "The style of a bullet at this level of nesting."
+ }
+ },
+ "id": "NestingLevel",
+ "description": "Contains properties describing the look and feel of a list bullet at a given\nlevel of nesting."
+ },
+ "TableCell": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "$ref": "TextContent",
+ "description": "The text content of the cell."
+ },
+ "tableCellProperties": {
+ "$ref": "TableCellProperties",
+ "description": "The properties of the table cell."
+ },
+ "location": {
+ "$ref": "TableCellLocation",
+ "description": "The location of the cell within the table."
+ },
+ "rowSpan": {
+ "description": "Row span of the cell.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "columnSpan": {
+ "description": "Column span of the cell.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "TableCell",
+ "description": "Properties and contents of each table cell."
+ },
+ "UpdateLinePropertiesRequest": {
+ "description": "Updates the properties of a Line.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the line the update is applied to."
+ },
+ "lineProperties": {
+ "$ref": "LineProperties",
+ "description": "The line properties to update."
+ },
+ "fields": {
+ "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"
+ }
+ },
+ "id": "UpdateLinePropertiesRequest"
+ },
+ "UpdateSlidesPositionRequest": {
+ "type": "object",
+ "properties": {
+ "insertionIndex": {
+ "type": "integer",
+ "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"
+ },
+ "slideObjectIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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."
+ }
+ },
+ "id": "UpdateSlidesPositionRequest",
+ "description": "Updates the position of slides in the presentation."
+ },
+ "TableCellBackgroundFill": {
+ "type": "object",
+ "properties": {
+ "propertyState": {
+ "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.",
+ "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 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."
+ },
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
+ }
+ },
+ "id": "TableCellBackgroundFill",
+ "description": "The table cell background fill."
+ },
+ "UpdatePagePropertiesRequest": {
+ "type": "object",
+ "properties": {
+ "fields": {
+ "type": "string",
+ "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"
+ },
+ "objectId": {
+ "description": "The object ID of the page the update is applied to.",
+ "type": "string"
+ },
+ "pageProperties": {
+ "$ref": "PageProperties",
+ "description": "The page properties to update."
+ }
+ },
+ "id": "UpdatePagePropertiesRequest",
+ "description": "Updates the properties of a Page."
+ },
+ "Group": {
+ "description": "A PageElement kind representing a\njoined collection of PageElements.",
+ "type": "object",
+ "properties": {
+ "children": {
+ "description": "The collection of elements in the group. The minimum size of a group is 2.",
+ "type": "array",
+ "items": {
+ "$ref": "PageElement"
+ }
+ }
+ },
+ "id": "Group"
+ },
+ "Placeholder": {
+ "type": "object",
+ "properties": {
+ "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",
+ "type": "integer"
+ },
+ "type": {
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, signifies it is not a placeholder.",
+ "Body text.",
+ "Chart or graph.",
+ "Clip art image.",
+ "Title centered.",
+ "Diagram.",
+ "Date and time.",
+ "Footer text.",
+ "Header text.",
+ "Multimedia.",
+ "Any content type.",
+ "Picture.",
+ "Number of a slide.",
+ "Subtitle.",
+ "Table.",
+ "Slide title.",
+ "Slide image."
+ ],
+ "enum": [
+ "NONE",
+ "BODY",
+ "CHART",
+ "CLIP_ART",
+ "CENTERED_TITLE",
+ "DIAGRAM",
+ "DATE_AND_TIME",
+ "FOOTER",
+ "HEADER",
+ "MEDIA",
+ "OBJECT",
+ "PICTURE",
+ "SLIDE_NUMBER",
+ "SUBTITLE",
+ "TABLE",
+ "TITLE",
+ "SLIDE_IMAGE"
+ ],
+ "description": "The type of the placeholder."
+ },
+ "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",
+ "description": "The placeholder information that uniquely identifies a placeholder shape."
+ },
+ "DuplicateObjectRequest": {
+ "type": "object",
+ "properties": {
+ "objectIds": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "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"
+ },
+ "objectId": {
+ "description": "The ID of the object to duplicate.",
+ "type": "string"
+ }
+ },
+ "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."
+ },
+ "ReplaceAllTextRequest": {
+ "description": "Replaces all instances of text matching a criteria with replace text.",
+ "type": "object",
+ "properties": {
+ "replaceText": {
+ "type": "string",
+ "description": "The text that will replace the matched text."
+ },
+ "pageObjectIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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 master,\nor if a page with that object ID doesn't exist in the presentation."
+ },
+ "containsText": {
+ "$ref": "SubstringMatchCriteria",
+ "description": "Finds text in a shape matching this substring."
+ }
+ },
+ "id": "ReplaceAllTextRequest"
+ },
+ "Page": {
+ "type": "object",
+ "properties": {
+ "slideProperties": {
+ "$ref": "SlideProperties",
+ "description": "Slide specific properties. Only set if page_type = SLIDE."
+ },
+ "pageProperties": {
+ "$ref": "PageProperties",
+ "description": "The properties of the page."
+ },
+ "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."
+ },
+ "pageElements": {
+ "description": "The page elements rendered on the page.",
+ "type": "array",
+ "items": {
+ "$ref": "PageElement"
+ }
+ },
+ "pageType": {
+ "enum": [
+ "SLIDE",
+ "MASTER",
+ "LAYOUT",
+ "NOTES",
+ "NOTES_MASTER"
+ ],
+ "description": "The type of the page.",
+ "type": "string",
+ "enumDescriptions": [
+ "A slide page.",
+ "A master slide page.",
+ "A layout page.",
+ "A notes page.",
+ "A notes master page."
+ ]
+ },
+ "notesProperties": {
+ "$ref": "NotesProperties",
+ "description": "Notes specific properties. Only set if page_type = NOTES."
+ }
+ },
+ "id": "Page",
+ "description": "A page in a presentation."
+ },
+ "UnmergeTableCellsRequest": {
+ "description": "Unmerges cells in a Table.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the table."
+ },
+ "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"
+ },
+ "ShapeBackgroundFill": {
+ "type": "object",
+ "properties": {
+ "propertyState": {
+ "enum": [
+ "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",
+ "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."
+ ]
+ },
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
+ }
+ },
+ "id": "ShapeBackgroundFill",
+ "description": "The shape background fill."
+ },
+ "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": {
+ "rightOffset": {
+ "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"
+ },
+ "angle": {
+ "type": "number",
+ "description": "The rotation angle of the crop window around its center, in radians.\nRotation angle is applied after the offset.",
+ "format": "float"
+ },
+ "topOffset": {
+ "description": "The offset specifies the top edge of the crop rectangle that is located\nbelow the original bounding rectangle top edge, relative to the object's\noriginal height.",
+ "format": "float",
+ "type": "number"
+ },
+ "leftOffset": {
+ "description": "The offset specifies the left edge of the crop rectangle that is located to\nthe right of the original bounding rectangle left edge, relative to the\nobject's original width.",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "CropProperties"
+ },
+ "ReplaceAllShapesWithSheetsChartRequest": {
+ "description": "Replaces all shapes that match the given criteria with the provided Google\nSheets chart. The chart will be scaled and centered to fit within the bounds\nof the original shape.\n\nNOTE: Replacing shapes with a chart requires at least one of the\nspreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.",
+ "type": "object",
+ "properties": {
+ "spreadsheetId": {
+ "type": "string",
+ "description": "The ID of the Google Sheets spreadsheet that contains the chart."
+ },
+ "linkingMode": {
+ "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",
+ "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."
+ ]
+ },
+ "containsText": {
+ "$ref": "SubstringMatchCriteria",
+ "description": "The criteria that the shapes must match in order to be replaced. The\nrequest will replace all of the shapes that contain the given text."
+ },
+ "chartId": {
+ "description": "The ID of the specific chart in the Google Sheets spreadsheet.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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": "ReplaceAllShapesWithSheetsChartRequest"
+ },
+ "Range": {
+ "description": "Specifies a contiguous range of an indexed collection, such as characters in\ntext.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enum": [
+ "RANGE_TYPE_UNSPECIFIED",
+ "FIXED_RANGE",
+ "FROM_START_INDEX",
+ "ALL"
+ ],
+ "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.",
+ "Starts the range at `start_index` and continues until the\nend of the collection. The `end_index` must not be specified.",
+ "Sets the range to be the whole length of the collection. Both the\n`start_index` and the `end_index` must not be\nspecified."
+ ]
+ },
+ "startIndex": {
+ "type": "integer",
+ "description": "The optional zero-based index of the beginning of the collection.\nRequired for `FIXED_RANGE` and `FROM_START_INDEX` ranges.",
+ "format": "int32"
+ },
+ "endIndex": {
+ "description": "The optional zero-based index of the end of the collection.\nRequired for `FIXED_RANGE` ranges.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Range"
+ },
+ "ColorStop": {
+ "type": "object",
+ "properties": {
+ "alpha": {
+ "description": "The alpha value of this color in the gradient band. Defaults to 1.0,\nfully opaque.",
+ "format": "float",
+ "type": "number"
+ },
+ "position": {
+ "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",
+ "description": "A color and position in a gradient band."
+ },
+ "CreateVideoRequest": {
+ "description": "Creates a video.",
+ "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"
+ },
+ "source": {
+ "type": "string",
+ "enumDescriptions": [
+ "The video source is unspecified.",
+ "The video source is YouTube."
+ ],
+ "enum": [
+ "SOURCE_UNSPECIFIED",
+ "YOUTUBE"
+ ],
+ "description": "The video source."
+ },
+ "elementProperties": {
+ "$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": {
+ "type": "string",
+ "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."
+ }
+ },
+ "id": "CreateVideoRequest"
+ },
+ "DuplicateObjectResponse": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The ID of the new duplicate object."
+ }
+ },
+ "id": "DuplicateObjectResponse",
+ "description": "The response of duplicating an object."
+ },
+ "ReplaceAllShapesWithImageRequest": {
+ "type": "object",
+ "properties": {
+ "imageUrl": {
+ "type": "string",
+ "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."
+ },
+ "replaceMethod": {
+ "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"
+ ],
+ "description": "The replace method."
+ },
+ "containsText": {
+ "$ref": "SubstringMatchCriteria",
+ "description": "If set, this request will replace all of the shapes that contain the\ngiven text."
+ },
+ "pageObjectIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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."
+ }
+ },
+ "id": "ReplaceAllShapesWithImageRequest",
+ "description": "Replaces all shapes that match the given criteria with the provided image."
+ },
+ "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."
+ }
+ },
+ "id": "MergeTableCellsRequest"
+ },
+ "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": {
+ "transform": {
+ "$ref": "AffineTransform",
+ "description": "Transform that encodes the translate, scale, and skew of the shadow,\nrelative to the alignment position."
+ },
+ "type": {
+ "enum": [
+ "SHADOW_TYPE_UNSPECIFIED",
+ "OUTER"
+ ],
+ "description": "The type of the shadow.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified shadow type.",
+ "Outer shadow."
+ ]
+ },
+ "alignment": {
+ "type": "string",
+ "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."
+ },
+ "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": {
+ "type": "boolean",
+ "description": "Whether the shadow should rotate with the shape."
+ },
+ "propertyState": {
+ "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",
+ "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."
+ ]
+ },
+ "blurRadius": {
+ "$ref": "Dimension",
+ "description": "The radius of the shadow blur. The larger the radius, the more diffuse the\nshadow becomes."
+ }
+ },
+ "id": "Shadow"
+ },
+ "UngroupObjectsRequest": {
+ "description": "Ungroups objects, such as groups.",
+ "type": "object",
+ "properties": {
+ "objectIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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."
+ }
+ },
+ "id": "UngroupObjectsRequest"
+ },
+ "DeleteTableRowRequest": {
+ "description": "Deletes a row from a table.",
+ "type": "object",
+ "properties": {
+ "tableObjectId": {
+ "type": "string",
+ "description": "The table to delete rows from."
+ },
+ "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."
+ }
+ },
+ "id": "DeleteTableRowRequest"
+ },
+ "Bullet": {
+ "type": "object",
+ "properties": {
+ "glyph": {
+ "type": "string",
+ "description": "The rendered bullet glyph for this paragraph."
+ },
+ "nestingLevel": {
+ "type": "integer",
+ "description": "The nesting level of this paragraph in the list.",
+ "format": "int32"
+ },
+ "bulletStyle": {
+ "$ref": "TextStyle",
+ "description": "The paragraph specific text style applied to this bullet."
+ },
+ "listId": {
+ "type": "string",
+ "description": "The ID of the list this paragraph belongs to."
+ }
+ },
+ "id": "Bullet",
+ "description": "Describes the bullet of a paragraph."
+ },
+ "OutlineFill": {
+ "type": "object",
+ "properties": {
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
+ }
+ },
+ "id": "OutlineFill",
+ "description": "The fill of the outline."
+ },
+ "TableCellLocation": {
+ "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",
+ "description": "A location of a single table cell within a table."
+ },
+ "CreateLineResponse": {
+ "description": "The result of creating a line.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created line.",
+ "type": "string"
+ }
+ },
+ "id": "CreateLineResponse"
+ },
+ "ReplaceAllTextResponse": {
+ "type": "object",
+ "properties": {
+ "occurrencesChanged": {
+ "type": "integer",
+ "description": "The number of occurrences changed by replacing all text.",
+ "format": "int32"
+ }
+ },
+ "id": "ReplaceAllTextResponse",
+ "description": "The result of replacing text."
+ },
+ "TableBorderFill": {
+ "type": "object",
+ "properties": {
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid fill."
+ }
+ },
+ "id": "TableBorderFill",
+ "description": "The fill of the border."
+ },
+ "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": {
+ "type": "string",
+ "description": "The object ID of the shape or table with the text to be styled."
+ },
+ "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": {
+ "$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"
+ },
+ "Shape": {
+ "type": "object",
+ "properties": {
+ "shapeType": {
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "TEXT_BOX",
+ "RECTANGLE",
+ "ROUND_RECTANGLE",
+ "ELLIPSE",
+ "ARC",
+ "BENT_ARROW",
+ "BENT_UP_ARROW",
+ "BEVEL",
+ "BLOCK_ARC",
+ "BRACE_PAIR",
+ "BRACKET_PAIR",
+ "CAN",
+ "CHEVRON",
+ "CHORD",
+ "CLOUD",
+ "CORNER",
+ "CUBE",
+ "CURVED_DOWN_ARROW",
+ "CURVED_LEFT_ARROW",
+ "CURVED_RIGHT_ARROW",
+ "CURVED_UP_ARROW",
+ "DECAGON",
+ "DIAGONAL_STRIPE",
+ "DIAMOND",
+ "DODECAGON",
+ "DONUT",
+ "DOUBLE_WAVE",
+ "DOWN_ARROW",
+ "DOWN_ARROW_CALLOUT",
+ "FOLDED_CORNER",
+ "FRAME",
+ "HALF_FRAME",
+ "HEART",
+ "HEPTAGON",
+ "HEXAGON",
+ "HOME_PLATE",
+ "HORIZONTAL_SCROLL",
+ "IRREGULAR_SEAL_1",
+ "IRREGULAR_SEAL_2",
+ "LEFT_ARROW",
+ "LEFT_ARROW_CALLOUT",
+ "LEFT_BRACE",
+ "LEFT_BRACKET",
+ "LEFT_RIGHT_ARROW",
+ "LEFT_RIGHT_ARROW_CALLOUT",
+ "LEFT_RIGHT_UP_ARROW",
+ "LEFT_UP_ARROW",
+ "LIGHTNING_BOLT",
+ "MATH_DIVIDE",
+ "MATH_EQUAL",
+ "MATH_MINUS",
+ "MATH_MULTIPLY",
+ "MATH_NOT_EQUAL",
+ "MATH_PLUS",
+ "MOON",
+ "NO_SMOKING",
+ "NOTCHED_RIGHT_ARROW",
+ "OCTAGON",
+ "PARALLELOGRAM",
+ "PENTAGON",
+ "PIE",
+ "PLAQUE",
+ "PLUS",
+ "QUAD_ARROW",
+ "QUAD_ARROW_CALLOUT",
+ "RIBBON",
+ "RIBBON_2",
+ "RIGHT_ARROW",
+ "RIGHT_ARROW_CALLOUT",
+ "RIGHT_BRACE",
+ "RIGHT_BRACKET",
+ "ROUND_1_RECTANGLE",
+ "ROUND_2_DIAGONAL_RECTANGLE",
+ "ROUND_2_SAME_RECTANGLE",
+ "RIGHT_TRIANGLE",
+ "SMILEY_FACE",
+ "SNIP_1_RECTANGLE",
+ "SNIP_2_DIAGONAL_RECTANGLE",
+ "SNIP_2_SAME_RECTANGLE",
+ "SNIP_ROUND_RECTANGLE",
+ "STAR_10",
+ "STAR_12",
+ "STAR_16",
+ "STAR_24",
+ "STAR_32",
+ "STAR_4",
+ "STAR_5",
+ "STAR_6",
+ "STAR_7",
+ "STAR_8",
+ "STRIPED_RIGHT_ARROW",
+ "SUN",
+ "TRAPEZOID",
+ "TRIANGLE",
+ "UP_ARROW",
+ "UP_ARROW_CALLOUT",
+ "UP_DOWN_ARROW",
+ "UTURN_ARROW",
+ "VERTICAL_SCROLL",
+ "WAVE",
+ "WEDGE_ELLIPSE_CALLOUT",
+ "WEDGE_RECTANGLE_CALLOUT",
+ "WEDGE_ROUND_RECTANGLE_CALLOUT",
+ "FLOW_CHART_ALTERNATE_PROCESS",
+ "FLOW_CHART_COLLATE",
+ "FLOW_CHART_CONNECTOR",
+ "FLOW_CHART_DECISION",
+ "FLOW_CHART_DELAY",
+ "FLOW_CHART_DISPLAY",
+ "FLOW_CHART_DOCUMENT",
+ "FLOW_CHART_EXTRACT",
+ "FLOW_CHART_INPUT_OUTPUT",
+ "FLOW_CHART_INTERNAL_STORAGE",
+ "FLOW_CHART_MAGNETIC_DISK",
+ "FLOW_CHART_MAGNETIC_DRUM",
+ "FLOW_CHART_MAGNETIC_TAPE",
+ "FLOW_CHART_MANUAL_INPUT",
+ "FLOW_CHART_MANUAL_OPERATION",
+ "FLOW_CHART_MERGE",
+ "FLOW_CHART_MULTIDOCUMENT",
+ "FLOW_CHART_OFFLINE_STORAGE",
+ "FLOW_CHART_OFFPAGE_CONNECTOR",
+ "FLOW_CHART_ONLINE_STORAGE",
+ "FLOW_CHART_OR",
+ "FLOW_CHART_PREDEFINED_PROCESS",
+ "FLOW_CHART_PREPARATION",
+ "FLOW_CHART_PROCESS",
+ "FLOW_CHART_PUNCHED_CARD",
+ "FLOW_CHART_PUNCHED_TAPE",
+ "FLOW_CHART_SORT",
+ "FLOW_CHART_SUMMING_JUNCTION",
+ "FLOW_CHART_TERMINATOR",
+ "ARROW_EAST",
+ "ARROW_NORTH_EAST",
+ "ARROW_NORTH",
+ "SPEECH",
+ "STARBURST",
+ "TEARDROP",
+ "ELLIPSE_RIBBON",
+ "ELLIPSE_RIBBON_2",
+ "CLOUD_CALLOUT",
+ "CUSTOM"
+ ],
"description": "The type of the shape.",
- "type": "string"
- },
- "text": {
- "$ref": "TextContent",
- "description": "The text content of the shape."
- },
- "placeholder": {
- "description": "Placeholders are shapes that are inherit from corresponding placeholders on\nlayouts and masters.\n\nIf set, the shape is a placeholder shape and any inherited properties\ncan be resolved by looking at the parent placeholder identified by the\nPlaceholder.parent_object_id field.",
- "$ref": "Placeholder"
- },
- "shapeProperties": {
- "description": "The properties of the shape.",
- "$ref": "ShapeProperties"
- }
- }
- },
- "Image": {
- "properties": {
- "imageProperties": {
- "$ref": "ImageProperties",
- "description": "The properties of the image."
- },
- "contentUrl": {
- "description": "An URL to an image with 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.",
- "type": "string"
- }
- },
- "id": "Image",
- "description": "A PageElement kind representing an\nimage.",
- "type": "object"
- },
- "AffineTransform": {
- "description": "AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ]\nto transform source coordinates (x,y) into destination coordinates (x', y')\naccording to:\n\n x' x = shear_y scale_y translate_y \n 1 [ 1 ]\n\nAfter transformation,\n\n x' = scale_x * x + shear_x * y + translate_x;\n y' = scale_y * y + shear_y * x + translate_y;\n\nThis message is therefore composed of these six matrix elements.",
- "type": "object",
- "properties": {
- "translateX": {
- "description": "The X coordinate translation element.",
- "format": "double",
- "type": "number"
- },
- "shearY": {
- "description": "The Y coordinate shearing element.",
- "format": "double",
- "type": "number"
- },
- "unit": {
- "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.",
- "A point, 1/72 of an inch."
- ],
- "enum": [
- "UNIT_UNSPECIFIED",
- "EMU",
- "PT"
- ],
- "description": "The units for translate elements.",
- "type": "string"
- },
- "scaleX": {
- "description": "The X coordinate scaling element.",
- "format": "double",
- "type": "number"
- },
- "shearX": {
- "description": "The X coordinate shearing element.",
- "format": "double",
- "type": "number"
- },
- "scaleY": {
- "description": "The Y coordinate scaling element.",
- "format": "double",
- "type": "number"
- },
- "translateY": {
- "description": "The Y coordinate translation element.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "AffineTransform"
- },
- "InsertTextRequest": {
- "description": "Inserts text into a shape or a table cell.",
- "type": "object",
- "properties": {
- "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."
- },
- "objectId": {
- "description": "The object ID of the shape or table where the text will be inserted.",
- "type": "string"
- },
- "text": {
- "description": "The text to be inserted.\n\nInserting a newline character will implicitly create a new\nParagraphMarker at that index.\nThe paragraph style of the new paragraph will be copied from the paragraph\nat the current insertion index, including lists and bullets.\n\nText styles for inserted text will be determined automatically, generally\npreserving the styling of neighboring text. In most cases, the text will be\nadded to the TextRun that exists at the\ninsertion index.\n\nSome control characters (U+0000-U+0008, U+000C-U+001F) and characters\nfrom the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF)\nwill be stripped out of the inserted text.",
- "type": "string"
- },
- "insertionIndex": {
- "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"
- }
- },
- "id": "InsertTextRequest"
- },
- "AutoText": {
- "description": "A TextElement kind that represents auto text.",
- "type": "object",
- "properties": {
- "type": {
- "description": "The type of this auto text.",
- "type": "string",
- "enumDescriptions": [
- "An unspecified autotext type.",
- "Type for autotext that represents the current slide number."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "SLIDE_NUMBER"
- ]
- },
- "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.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created video.",
- "type": "string"
- }
- },
- "id": "CreateVideoResponse"
- },
- "DeleteTextRequest": {
- "description": "Deletes text from a shape or a table cell.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the shape or table from which the text will be deleted.",
- "type": "string"
- },
- "textRange": {
- "$ref": "Range",
- "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": {
- "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"
- },
- "UpdatePageElementTransformRequest": {
- "description": "Updates the transform of a page element.\n\nUpdating the transform of a group will change the absolute transform of the\npage elements in that group, which can change their visual appearance. See\nthe documentation for PageElement.transform for more details.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the page element to update.",
- "type": "string"
- },
- "transform": {
- "$ref": "AffineTransform",
- "description": "The input transform matrix used to update the page element."
- },
- "applyMode": {
- "description": "The apply mode of the transform update.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified mode.",
- "Applies the new AffineTransform matrix to the existing one, and\nreplaces the existing one with the resulting concatenation.",
- "Replaces the existing AffineTransform matrix with the new one."
- ],
- "enum": [
- "APPLY_MODE_UNSPECIFIED",
- "RELATIVE",
- "ABSOLUTE"
- ]
- }
- },
- "id": "UpdatePageElementTransformRequest"
- },
- "DeleteObjectRequest": {
- "description": "Deletes an object, either pages or\npage elements, from the\npresentation.",
- "type": "object",
- "properties": {
- "objectId": {
- "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"
- },
- "Dimension": {
- "description": "A magnitude in a single direction in the specified units.",
- "type": "object",
- "properties": {
- "magnitude": {
- "description": "The magnitude.",
- "format": "double",
- "type": "number"
- },
- "unit": {
- "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.",
- "A point, 1/72 of an inch."
- ],
- "enum": [
- "UNIT_UNSPECIFIED",
- "EMU",
- "PT"
- ],
- "description": "The units for magnitude.",
- "type": "string"
- }
- },
- "id": "Dimension"
- },
- "TextElement": {
- "description": "A TextElement describes the content of a range of indices in the text content\nof a Shape or TableCell.",
- "type": "object",
- "properties": {
- "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.",
- "$ref": "ParagraphMarker"
- },
- "startIndex": {
- "description": "The zero-based start index of this text element, in Unicode code units.",
- "format": "int32",
- "type": "integer"
- },
- "endIndex": {
- "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": {
- "description": "A TextElement representing a spot in the text that is dynamically\nreplaced with content that can change over time.",
- "$ref": "AutoText"
- }
- },
- "id": "TextElement"
- },
- "LineFill": {
- "description": "The fill of the line.",
- "type": "object",
- "properties": {
- "solidFill": {
- "description": "Solid color fill.",
- "$ref": "SolidFill"
- }
- },
- "id": "LineFill"
- },
- "VideoProperties": {
- "properties": {
- "outline": {
- "$ref": "Outline",
- "description": "The outline of the video. The default outline matches the defaults for new\nvideos created in the Slides editor."
- }
- },
- "id": "VideoProperties",
- "description": "The properties of the Video.",
- "type": "object"
- },
- "InsertTableRowsRequest": {
- "properties": {
- "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"
- },
- "number": {
- "description": "The number of rows to be inserted. Maximum 20 per request.",
- "format": "int32",
- "type": "integer"
- },
- "cellLocation": {
- "$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."
- }
- },
- "id": "InsertTableRowsRequest",
- "description": "Inserts rows into a table.",
- "type": "object"
- },
- "LayoutProperties": {
- "description": "The properties of Page are only\nrelevant for pages with page_type LAYOUT.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the layout.",
- "type": "string"
- },
- "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": {
- "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": {
- "link": {
- "$ref": "Link",
- "description": "The hyperlink destination of the line. If unset, there is no link."
- },
- "dashStyle": {
- "enum": [
- "DASH_STYLE_UNSPECIFIED",
- "SOLID",
- "DOT",
- "DASH",
- "DASH_DOT",
- "LONG_DASH",
- "LONG_DASH_DOT"
- ],
- "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.",
- "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
- "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
- "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
- "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
- "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
- ]
- },
- "startArrow": {
- "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"
- ],
- "description": "The style of the arrow at the beginning of the line."
- },
- "endArrow": {
- "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",
- "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."
- ]
- },
- "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."
- }
- },
- "id": "LineProperties"
- },
- "Presentation": {
- "description": "A Google Slides presentation.",
- "type": "object",
- "properties": {
- "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."
- },
- "title": {
- "description": "The title of the presentation.",
- "type": "string"
- },
- "layouts": {
- "description": "The layouts in the presentation. A layout is a template that determines\nhow content is arranged and styled on the slides that inherit from that\nlayout.",
- "type": "array",
- "items": {
- "$ref": "Page"
- }
- },
- "masters": {
- "description": "The slide masters in the presentation. A slide master contains all common\npage elements and the common properties for a set of layouts. They serve\nthree purposes:\n\n- Placeholder shapes on a master contain the default text styles and shape\n properties of all placeholder shapes on pages that use that master.\n- The master page properties define the common page properties inherited by\n its layouts.\n- Any other shapes on the master slide will appear on all slides using that\n master, regardless of their layout.",
- "type": "array",
- "items": {
- "$ref": "Page"
- }
- },
- "locale": {
- "type": "string",
- "description": "The locale of the presentation, as an IETF BCP 47 language tag."
- },
- "pageSize": {
- "description": "The size of pages in the presentation.",
- "$ref": "Size"
- },
- "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"
- }
- }
- },
- "id": "Presentation"
- },
- "OpaqueColor": {
- "description": "A themeable solid color value.",
- "type": "object",
- "properties": {
- "themeColor": {
- "enum": [
- "THEME_COLOR_TYPE_UNSPECIFIED",
- "DARK1",
- "LIGHT1",
- "DARK2",
- "LIGHT2",
- "ACCENT1",
- "ACCENT2",
- "ACCENT3",
- "ACCENT4",
- "ACCENT5",
- "ACCENT6",
- "HYPERLINK",
- "FOLLOWED_HYPERLINK",
- "TEXT1",
- "BACKGROUND1",
- "TEXT2",
- "BACKGROUND2"
- ],
- "description": "An opaque theme color.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified theme color. This value should not be used.",
- "Represents the first dark color.",
- "Represents the first light color.",
- "Represents the second dark color.",
- "Represents the second light color.",
- "Represents the first accent color.",
- "Represents the second accent color.",
- "Represents the third accent color.",
- "Represents the fourth accent color.",
- "Represents the fifth accent color.",
- "Represents the sixth accent color.",
- "Represents the color to use for hyperlinks.",
- "Represents the color to use for visited hyperlinks.",
- "Represents the first text color.",
- "Represents the first background color.",
- "Represents the second text color.",
- "Represents the second background color."
- ]
- },
- "rgbColor": {
- "$ref": "RgbColor",
- "description": "An opaque RGB color."
- }
- },
- "id": "OpaqueColor"
- },
- "ImageProperties": {
- "properties": {
- "shadow": {
- "description": "The shadow of the image. If not set, the image has no shadow. This property\nis read-only.",
- "$ref": "Shadow"
- },
- "link": {
- "description": "The hyperlink destination of the image. If unset, there is no link.",
- "$ref": "Link"
- },
- "contrast": {
- "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": {
- "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."
- },
- "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.",
- "format": "float",
- "type": "number"
- },
- "transparency": {
- "description": "The transparency effect of the image. The value should be in the interval\n[0.0, 1.0], where 0 means no effect and 1 means completely transparent.\nThis property is read-only.",
- "format": "float",
- "type": "number"
- }
- },
- "id": "ImageProperties",
- "description": "The properties of the Image.",
- "type": "object"
- },
- "ReplaceAllShapesWithImageResponse": {
- "id": "ReplaceAllShapesWithImageResponse",
- "description": "The result of replacing shapes with an image.",
- "type": "object",
- "properties": {
- "occurrencesChanged": {
- "type": "integer",
- "description": "The number of shapes replaced with images.",
- "format": "int32"
- }
- }
- },
- "Line": {
- "description": "A PageElement kind representing a\nline, curved connector, or bent connector.",
- "type": "object",
- "properties": {
- "lineType": {
- "enumDescriptions": [
- "An unspecified line type.",
- "Straight connector 1 form. Corresponds to ECMA-376 ST_ShapeType\n'straightConnector1'.",
- "Bent connector 2 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector2'.",
- "Bent connector 3 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector3'.",
- "Bent connector 4 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector4'.",
- "Bent connector 5 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector5'.",
- "Curved connector 2 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector2'.",
- "Curved connector 3 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector3'.",
- "Curved connector 4 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector4'.",
- "Curved connector 5 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector5'."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "STRAIGHT_CONNECTOR_1",
- "BENT_CONNECTOR_2",
- "BENT_CONNECTOR_3",
- "BENT_CONNECTOR_4",
- "BENT_CONNECTOR_5",
- "CURVED_CONNECTOR_2",
- "CURVED_CONNECTOR_3",
- "CURVED_CONNECTOR_4",
- "CURVED_CONNECTOR_5"
- ],
- "description": "The type of the line.",
- "type": "string"
- },
- "lineProperties": {
- "$ref": "LineProperties",
- "description": "The properties of the line."
- }
- },
- "id": "Line"
- },
- "BatchUpdatePresentationResponse": {
- "description": "Response message from a batch update.",
- "type": "object",
- "properties": {
- "presentationId": {
- "description": "The presentation the updates were applied to.",
- "type": "string"
- },
- "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"
- }
- }
- },
- "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": {
- "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"
- },
- "elementProperties": {
- "description": "The element properties for the chart.\n\nWhen the aspect ratio of the provided size does not match the chart aspect\nratio, the chart is scaled and centered with respect to the size in order\nto maintain aspect ratio. The provided transform is applied after this\noperation.",
- "$ref": "PageElementProperties"
- },
- "spreadsheetId": {
- "description": "The ID of the Google Sheets spreadsheet that contains the chart.",
- "type": "string"
- },
- "linkingMode": {
- "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."
- ],
- "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."
- },
- "chartId": {
- "description": "The ID of the specific chart in the Google Sheets spreadsheet.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "CreateSheetsChartRequest"
- },
- "CreateImageResponse": {
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created image.",
- "type": "string"
- }
- },
- "id": "CreateImageResponse",
- "description": "The result of creating an image."
- },
- "SlideProperties": {
- "properties": {
- "layoutObjectId": {
- "description": "The object ID of the layout that this slide is based on.",
- "type": "string"
- },
- "masterObjectId": {
- "description": "The object ID of the master that this slide is based on.",
- "type": "string"
- },
- "notesPage": {
- "$ref": "Page",
- "description": "The notes page that this slide is associated with. It defines the visual\nappearance of a notes page when printing or exporting slides with speaker\nnotes. A notes page inherits properties from the\nnotes master.\nThe placeholder shape with type BODY on the notes page contains the speaker\nnotes for this slide. The ID of this shape is identified by the\nspeakerNotesObjectId field.\nThe notes page is read-only except for the text content and styles of the\nspeaker notes shape."
- }
- },
- "id": "SlideProperties",
- "description": "The properties of Page that are only\nrelevant for pages with page_type SLIDE.",
- "type": "object"
- },
- "MasterProperties": {
- "description": "The properties of Page that are only\nrelevant for pages with page_type MASTER.",
- "type": "object",
- "properties": {
- "displayName": {
- "type": "string",
- "description": "The human-readable name of the master."
- }
- },
- "id": "MasterProperties"
- },
- "Response": {
- "description": "A single response from an update.",
- "type": "object",
- "properties": {
- "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": {
- "$ref": "CreateTableResponse",
- "description": "The result of creating a table."
- },
- "replaceAllText": {
- "$ref": "ReplaceAllTextResponse",
- "description": "The result of replacing text."
- },
- "createSlide": {
- "$ref": "CreateSlideResponse",
- "description": "The result of creating a slide."
- },
- "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": {
- "$ref": "CreateVideoResponse",
- "description": "The result of creating a video."
- },
- "createSheetsChart": {
- "$ref": "CreateSheetsChartResponse",
- "description": "The result of creating a Google Sheets chart."
- },
- "replaceAllShapesWithSheetsChart": {
- "$ref": "ReplaceAllShapesWithSheetsChartResponse",
- "description": "The result of replacing all shapes matching some criteria with a Google\nSheets chart."
- },
- "groupObjects": {
- "description": "The result of grouping objects.",
- "$ref": "GroupObjectsResponse"
- }
- },
- "id": "Response"
- },
- "SubstringMatchCriteria": {
- "description": "A criteria that matches a specific string of text in a shape or table.",
- "type": "object",
- "properties": {
- "text": {
- "description": "The text to search for in the shape or table.",
- "type": "string"
- },
- "matchCase": {
- "description": "Indicates whether the search should respect case:\n\n- `True`: the search is case sensitive.\n- `False`: the search is case insensitive.",
- "type": "boolean"
- }
- },
- "id": "SubstringMatchCriteria"
- },
- "LayoutReference": {
- "properties": {
- "layoutId": {
- "description": "Layout ID: the object ID of one of the layouts in the presentation.",
- "type": "string"
- },
- "predefinedLayout": {
- "enumDescriptions": [
- "Unspecified layout.",
- "Blank layout, with no placeholders.",
- "Layout with a caption at the bottom.",
- "Layout with a title and a subtitle.",
- "Layout with a title and body.",
- "Layout with a title and two columns.",
- "Layout with only a title.",
- "Layout with a section title.",
- "Layout with a title and subtitle on one side and description on the other.",
- "Layout with one title and one body, arranged in a single column.",
- "Layout with a main point.",
- "Layout with a big number heading."
- ],
- "enum": [
- "PREDEFINED_LAYOUT_UNSPECIFIED",
- "BLANK",
- "CAPTION_ONLY",
- "TITLE",
- "TITLE_AND_BODY",
- "TITLE_AND_TWO_COLUMNS",
- "TITLE_ONLY",
- "SECTION_HEADER",
- "SECTION_TITLE_AND_DESCRIPTION",
- "ONE_COLUMN_TEXT",
- "MAIN_POINT",
- "BIG_NUMBER"
- ],
- "description": "Predefined layout.",
- "type": "string"
- }
- },
- "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"
- },
- "TextRun": {
- "description": "A TextElement kind that represents a run of text that all has the same\nstyling.",
- "type": "object",
- "properties": {
- "content": {
- "description": "The text of this run.",
- "type": "string"
- },
- "style": {
- "$ref": "TextStyle",
- "description": "The styling applied to this run."
- }
- },
- "id": "TextRun"
- },
- "TableRange": {
- "description": "A table range represents a reference to a subset of a table.\n\nIt's important to note that the cells specified by a table range do not\nnecessarily form a rectangle. For example, let's say we have a 3 x 3 table\nwhere all the cells of the last row are merged together. The table looks\nlike this:\n\n \n [ ]\n\nA table range with location = (0, 0), row span = 3 and column span = 2\nspecifies the following cells:\n\n x x \n [ x ]",
- "type": "object",
- "properties": {
- "location": {
- "$ref": "TableCellLocation",
- "description": "The starting location of the table range."
- },
- "rowSpan": {
- "description": "The row span of the table range.",
- "format": "int32",
- "type": "integer"
- },
- "columnSpan": {
- "description": "The column span of the table range.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TableRange"
- },
- "CreateTableRequest": {
- "description": "Creates a new table.",
- "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"
- },
- "columns": {
- "description": "Number of columns in the table.",
- "format": "int32",
- "type": "integer"
- },
- "elementProperties": {
- "$ref": "PageElementProperties",
- "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."
- },
- "rows": {
- "description": "Number of rows in the table.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "CreateTableRequest"
- },
- "CreateTableResponse": {
- "description": "The result of creating a table.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created table.",
- "type": "string"
- }
- },
- "id": "CreateTableResponse"
- },
- "Table": {
- "description": "A PageElement kind representing a\ntable.",
- "type": "object",
- "properties": {
- "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",
- "items": {
- "$ref": "TableBorderRow"
- }
- },
- "verticalBorderRows": {
- "description": "Properties of vertical cell borders.\n\nA table's vertical cell borders are represented as a grid. The grid has the\nsame number of rows as the table and one more column than the number of\ncolumns in the table. For example, if the table is 3 x 3, its vertical\nborders will be represented as a grid with 3 rows and 4 columns.",
- "type": "array",
- "items": {
- "$ref": "TableBorderRow"
- }
- },
- "rows": {
- "description": "Number of rows in the table.",
- "format": "int32",
- "type": "integer"
- },
- "tableColumns": {
- "description": "Properties of each column.",
- "type": "array",
- "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"
- },
- "GroupObjectsRequest": {
- "description": "Groups objects to create an object group. For example, groups PageElements to create a Group on the same page as all the children.",
- "type": "object",
- "properties": {
- "groupObjectId": {
- "description": "A user-supplied object ID for the group to be created.\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"
- },
- "childrenObjectIds": {
- "description": "The object IDs of the objects to group.\n\nOnly page elements can be grouped. There should be at least two page\nelements on the same page that are not already in another group. Some page\nelements, such as videos, tables and placeholder shapes cannot be grouped.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "GroupObjectsRequest"
- },
- "TableBorderRow": {
- "description": "Contents of each border row in a table.",
- "type": "object",
- "properties": {
- "tableBorderCells": {
- "description": "Properties of each border cell. When a border's adjacent table cells are\nmerged, it is not included in the response.",
- "type": "array",
- "items": {
- "$ref": "TableBorderCell"
- }
- }
- },
- "id": "TableBorderRow"
- },
- "PageBackgroundFill": {
- "description": "The page background fill.",
- "type": "object",
- "properties": {
- "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 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": {
- "$ref": "StretchedPictureFill",
- "description": "Stretched picture fill."
- },
- "solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
- }
- },
- "id": "PageBackgroundFill"
- },
- "SheetsChart": {
- "properties": {
- "spreadsheetId": {
- "description": "The ID of the Google Sheets spreadsheet that contains the source chart.",
- "type": "string"
- },
- "chartId": {
- "description": "The ID of the specific chart in the Google Sheets spreadsheet that is\nembedded.",
- "format": "int32",
- "type": "integer"
- },
- "sheetsChartProperties": {
- "$ref": "SheetsChartProperties",
- "description": "The properties of the Sheets chart."
- },
- "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",
- "description": "A PageElement kind representing\na linked chart embedded from Google Sheets.",
- "type": "object"
- },
- "SolidFill": {
- "description": "A solid color fill. The page or page element is filled entirely with the\nspecified color value.\n\nIf any field is unset, its value may be inherited from a parent placeholder\nif it exists.",
- "type": "object",
- "properties": {
- "alpha": {
- "description": "The fraction of this `color` that should be applied to the pixel.\nThat is, the final pixel color is defined by the equation:\n\n pixel color = alpha * (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.",
- "format": "float",
- "type": "number"
- },
- "color": {
- "description": "The color value of the solid fill.",
- "$ref": "OpaqueColor"
- }
- },
- "id": "SolidFill"
- },
- "ThemeColorPair": {
- "description": "A pair mapping a theme color type to the concrete color it represents.",
- "type": "object",
- "properties": {
- "color": {
- "description": "The concrete color corresponding to the theme color type above.",
- "$ref": "RgbColor"
- },
- "type": {
- "enumDescriptions": [
- "Unspecified theme color. This value should not be used.",
- "Represents the first dark color.",
- "Represents the first light color.",
- "Represents the second dark color.",
- "Represents the second light color.",
- "Represents the first accent color.",
- "Represents the second accent color.",
- "Represents the third accent color.",
- "Represents the fourth accent color.",
- "Represents the fifth accent color.",
- "Represents the sixth accent color.",
- "Represents the color to use for hyperlinks.",
- "Represents the color to use for visited hyperlinks.",
- "Represents the first text color.",
- "Represents the first background color.",
- "Represents the second text color.",
- "Represents the second background color."
- ],
- "enum": [
- "THEME_COLOR_TYPE_UNSPECIFIED",
- "DARK1",
- "LIGHT1",
- "DARK2",
- "LIGHT2",
- "ACCENT1",
- "ACCENT2",
- "ACCENT3",
- "ACCENT4",
- "ACCENT5",
- "ACCENT6",
- "HYPERLINK",
- "FOLLOWED_HYPERLINK",
- "TEXT1",
- "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.",
- "type": "object",
- "properties": {
- "opaqueColor": {
- "$ref": "OpaqueColor",
- "description": "If set, this will be used as an opaque color. If unset, this represents\na transparent color."
- }
- },
- "id": "OptionalColor"
- },
- "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": {
- "transform": {
- "description": "The transform for the element.",
- "$ref": "AffineTransform"
- },
- "pageObjectId": {
- "type": "string",
- "description": "The object ID of the page where the element is located."
- },
- "size": {
- "$ref": "Size",
- "description": "The size of the element."
- }
- },
- "id": "PageElementProperties"
- },
- "SheetsChartProperties": {
- "id": "SheetsChartProperties",
- "description": "The properties of the SheetsChart.",
- "type": "object",
- "properties": {
- "chartImageProperties": {
- "$ref": "ImageProperties",
- "description": "The properties of the embedded chart image."
- }
- }
- },
- "StretchedPictureFill": {
- "description": "The stretched picture fill. The page or page element is filled entirely with\nthe specified picture. The picture is stretched to fit its container.",
- "type": "object",
- "properties": {
- "size": {
- "description": "The original size of the picture fill. This field is read-only.",
- "$ref": "Size"
- },
- "contentUrl": {
- "description": "Reading the content_url:\n\nAn URL to a picture with a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the picture as the original requester. Access to the\npicture may be lost if the presentation's sharing settings change.\n\nWriting the content_url:\n\nThe picture is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Pictures 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": "StretchedPictureFill"
- },
- "DeleteTableColumnRequest": {
- "description": "Deletes a column from a table.",
- "type": "object",
- "properties": {
- "tableObjectId": {
- "description": "The table to delete columns from.",
- "type": "string"
- },
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The reference table cell location from which a column will be deleted.\n\nThe column this cell spans will be deleted. If this is a merged cell,\nmultiple columns will be deleted. If no columns remain in the table after\nthis deletion, the whole table is deleted."
- }
- },
- "id": "DeleteTableColumnRequest"
- },
- "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": {
- "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"
- },
- "cellLocation": {
- "$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": {
- "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"
- }
- },
- "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.",
- "type": "object",
- "properties": {
- "listId": {
- "description": "The ID of the list.",
- "type": "string"
- },
- "nestingLevel": {
- "description": "A map of nesting levels to the properties of bullets at the associated\nlevel. A list has at most nine levels of nesting, so the possible values\nfor the keys of this map are 0 through 8, inclusive.",
- "type": "object",
- "additionalProperties": {
- "$ref": "NestingLevel"
- }
- }
- },
- "id": "List"
- },
- "WeightedFontFamily": {
- "description": "Represents a font family and weight used to style a TextRun.",
- "type": "object",
- "properties": {
- "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`.",
- "type": "string"
- },
- "weight": {
- "type": "integer",
- "description": "The rendered weight of the text. This field can have any value that is a\nmultiple of `100` between `100` and `900`, inclusive. This range\ncorresponds to the numerical values described in the CSS 2.1\nSpecification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),\nwith non-numerical values disallowed. Weights greater than or equal to\n`700` are considered bold, and weights less than `700`are not bold. The\ndefault value is `400` (\"normal\").",
- "format": "int32"
- }
- },
- "id": "WeightedFontFamily"
- },
- "PageElement": {
- "description": "A visual element rendered on a page.",
- "type": "object",
- "properties": {
- "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": {
- "$ref": "WordArt",
- "description": "A word art page element."
- },
- "table": {
- "$ref": "Table",
- "description": "A table page element."
- },
- "transform": {
- "$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.",
- "type": "string"
- },
- "shape": {
- "$ref": "Shape",
- "description": "A generic shape."
- },
- "line": {
- "$ref": "Line",
- "description": "A line page element."
- },
- "description": {
- "description": "The description of the page element. Combined with title to display alt\ntext.",
- "type": "string"
- },
- "elementGroup": {
- "description": "A collection of page elements joined as a single unit.",
- "$ref": "Group"
- }
- },
- "id": "PageElement"
- },
- "CreateImageRequest": {
- "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"
- },
- "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."
- }
- },
- "id": "CreateImageRequest"
- },
- "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": {
- "$ref": "Range",
- "description": "The range of text to apply the bullet presets to, based on TextElement indexes."
- },
- "bulletPreset": {
- "enumDescriptions": [
- "A bulleted list with a `DISC`, `CIRCLE` and `SQUARE` bullet glyph for the\nfirst 3 list nesting levels.",
- "A bulleted list with a `DIAMONDX`, `ARROW3D` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with `CHECKBOX` bullet glyphs for all list nesting levels.",
- "A bulleted list with a `ARROW`, `DIAMOND` and `DISC` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with a `STAR`, `CIRCLE` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with a `ARROW3D`, `CIRCLE` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with a `LEFTTRIANGLE`, `DIAMOND` and `DISC` bullet glyph\nfor the first 3 list nesting levels.",
- "A bulleted list with a `DIAMONDX`, `HOLLOWDIAMOND` and `SQUARE` bullet\nglyph for the first 3 list nesting levels.",
- "A bulleted list with a `DIAMOND`, `CIRCLE` and `SQUARE` bullet glyph\nfor the first 3 list nesting levels.",
- "A numbered list with `DIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods.",
- "A numbered list with `DIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by parenthesis.",
- "A numbered list with `DIGIT` numeric glyphs separated by periods, where\neach nesting level uses the previous nesting level's glyph as a prefix.\nFor example: '1.', '1.1.', '2.', '2.2.'.",
- "A numbered list with `UPPERALPHA`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods.",
- "A numbered list with `UPPERROMAN`, `UPPERALPHA` and `DIGIT` numeric glyphs\nfor the first 3 list nesting levels, followed by periods.",
- "A numbered list with `ZERODIGIT`, `ALPHA` and `ROMAN` numeric glyphs for\nthe first 3 list nesting levels, followed by periods."
- ],
- "enum": [
- "BULLET_DISC_CIRCLE_SQUARE",
- "BULLET_DIAMONDX_ARROW3D_SQUARE",
- "BULLET_CHECKBOX",
- "BULLET_ARROW_DIAMOND_DISC",
- "BULLET_STAR_CIRCLE_SQUARE",
- "BULLET_ARROW3D_CIRCLE_SQUARE",
- "BULLET_LEFTTRIANGLE_DIAMOND_DISC",
- "BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE",
- "BULLET_DIAMOND_CIRCLE_SQUARE",
- "NUMBERED_DIGIT_ALPHA_ROMAN",
- "NUMBERED_DIGIT_ALPHA_ROMAN_PARENS",
- "NUMBERED_DIGIT_NESTED",
- "NUMBERED_UPPERALPHA_ALPHA_ROMAN",
- "NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT",
- "NUMBERED_ZERODIGIT_ALPHA_ROMAN"
- ],
- "description": "The kinds of bullet glyphs to be used. Defaults to the\n`BULLET_DISC_CIRCLE_SQUARE` preset.",
- "type": "string"
- },
- "cellLocation": {
- "$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."
- }
- },
- "id": "CreateParagraphBulletsRequest"
- },
- "Size": {
- "description": "A width and height.",
- "type": "object",
- "properties": {
- "height": {
- "$ref": "Dimension",
- "description": "The height of the object."
- },
- "width": {
- "description": "The width of the object.",
- "$ref": "Dimension"
- }
- },
- "id": "Size"
- },
- "TextStyle": {
- "properties": {
- "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": {
- "$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."
- },
- "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"
- },
- "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"
- },
- "fontSize": {
- "$ref": "Dimension",
- "description": "The size of the text's font. When read, the `font_size` will specified in\npoints."
- },
- "baselineOffset": {
- "enum": [
- "BASELINE_OFFSET_UNSPECIFIED",
- "NONE",
- "SUPERSCRIPT",
- "SUBSCRIPT"
- ],
- "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.",
- "type": "string",
- "enumDescriptions": [
- "The text's baseline offset is inherited from the parent.",
- "The text is not vertically offset.",
- "The text is vertically offset upwards (superscript).",
- "The text is vertically offset downwards (subscript)."
- ]
- },
- "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"
- }
- },
- "id": "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"
- },
- "UpdateVideoPropertiesRequest": {
- "type": "object",
- "properties": {
- "objectId": {
- "type": "string",
- "description": "The object ID of the video the updates are applied to."
- },
- "videoProperties": {
- "description": "The video properties to update.",
- "$ref": "VideoProperties"
- },
- "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"
- }
- },
- "id": "UpdateVideoPropertiesRequest",
- "description": "Update the properties of a Video."
- },
- "Request": {
- "id": "Request",
- "description": "A single kind of update to apply to a presentation.",
- "type": "object",
- "properties": {
- "replaceAllShapesWithImage": {
- "description": "Replaces all shapes matching some criteria with an image.",
- "$ref": "ReplaceAllShapesWithImageRequest"
- },
- "replaceAllText": {
- "$ref": "ReplaceAllTextRequest",
- "description": "Replaces all instances of specified text."
- },
- "updateImageProperties": {
- "$ref": "UpdateImagePropertiesRequest",
- "description": "Updates the properties of an Image."
- },
- "createSlide": {
- "description": "Creates a new slide.",
- "$ref": "CreateSlideRequest"
- },
- "insertTableRows": {
- "$ref": "InsertTableRowsRequest",
- "description": "Inserts rows into a table."
- },
- "updateLineProperties": {
- "$ref": "UpdateLinePropertiesRequest",
- "description": "Updates the properties of a Line."
- },
- "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": {
- "$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."
- },
- "insertText": {
- "$ref": "InsertTextRequest",
- "description": "Inserts text into a shape or table cell."
- },
- "updateTableColumnProperties": {
- "description": "Updates the properties of a Table\ncolumn.",
- "$ref": "UpdateTableColumnPropertiesRequest"
- },
- "deleteText": {
- "$ref": "DeleteTextRequest",
- "description": "Deletes text from a shape or a table cell."
- },
- "updatePageProperties": {
- "$ref": "UpdatePagePropertiesRequest",
- "description": "Updates the properties of a Page."
- },
- "deleteParagraphBullets": {
- "$ref": "DeleteParagraphBulletsRequest",
- "description": "Deletes bullets from paragraphs."
- },
- "createShape": {
- "$ref": "CreateShapeRequest",
- "description": "Creates a new shape."
- },
- "updateTableBorderProperties": {
- "description": "Updates the properties of the table borders in a Table.",
- "$ref": "UpdateTableBorderPropertiesRequest"
- },
- "insertTableColumns": {
- "$ref": "InsertTableColumnsRequest",
- "description": "Inserts columns into a table."
- },
- "mergeTableCells": {
- "description": "Merges cells in a Table.",
- "$ref": "MergeTableCellsRequest"
- },
- "refreshSheetsChart": {
- "description": "Refreshes a Google Sheets chart.",
- "$ref": "RefreshSheetsChartRequest"
- },
- "createTable": {
- "$ref": "CreateTableRequest",
- "description": "Creates a new table."
- },
- "updateTableCellProperties": {
- "description": "Updates the properties of a TableCell.",
- "$ref": "UpdateTableCellPropertiesRequest"
- },
- "deleteObject": {
- "description": "Deletes a page or page element from the presentation.",
- "$ref": "DeleteObjectRequest"
- },
- "updateParagraphStyle": {
- "$ref": "UpdateParagraphStyleRequest",
- "description": "Updates the styling of paragraphs within a Shape or Table."
- },
- "deleteTableColumn": {
- "$ref": "DeleteTableColumnRequest",
- "description": "Deletes a column from a table."
- },
- "duplicateObject": {
- "description": "Duplicates a slide or page element.",
- "$ref": "DuplicateObjectRequest"
- },
- "updateVideoProperties": {
- "description": "Updates the properties of a Video.",
- "$ref": "UpdateVideoPropertiesRequest"
- },
- "createLine": {
- "$ref": "CreateLineRequest",
- "description": "Creates a line."
- },
- "createImage": {
- "$ref": "CreateImageRequest",
- "description": "Creates an image."
- },
- "createParagraphBullets": {
- "$ref": "CreateParagraphBulletsRequest",
- "description": "Creates bullets for paragraphs."
- },
- "createVideo": {
- "description": "Creates a video.",
- "$ref": "CreateVideoRequest"
- },
- "createSheetsChart": {
- "$ref": "CreateSheetsChartRequest",
- "description": "Creates an embedded Google Sheets chart."
- },
- "replaceAllShapesWithSheetsChart": {
- "$ref": "ReplaceAllShapesWithSheetsChartRequest",
- "description": "Replaces all shapes matching some criteria with a Google Sheets chart."
- },
- "unmergeTableCells": {
- "$ref": "UnmergeTableCellsRequest",
- "description": "Unmerges cells in a Table."
- },
- "updatePageElementTransform": {
- "description": "Updates the transform of a page element.",
- "$ref": "UpdatePageElementTransformRequest"
- },
- "updateTextStyle": {
- "$ref": "UpdateTextStyleRequest",
- "description": "Updates the styling of text within a Shape or Table."
- },
- "updateTableRowProperties": {
- "description": "Updates the properties of a Table row.",
- "$ref": "UpdateTableRowPropertiesRequest"
- }
- }
- },
- "UpdateImagePropertiesRequest": {
- "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": {
- "$ref": "ImageProperties",
- "description": "The image properties to update."
- },
- "objectId": {
- "type": "string",
- "description": "The object ID of the image the updates are applied to."
- }
- },
- "id": "UpdateImagePropertiesRequest",
- "description": "Update the properties of an Image.",
- "type": "object"
- },
- "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": {
- "description": "The amount of indentation for the start of the first line of the paragraph.\nIf unset, the value is inherited from the parent.",
- "$ref": "Dimension"
- },
- "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"
- },
- "alignment": {
- "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.",
- "The paragraph is centered.",
- "The paragraph is aligned to the end of the line. Right-aligned for\nLTR text, left-aligned otherwise.",
- "The paragraph is justified."
- ],
- "enum": [
- "ALIGNMENT_UNSPECIFIED",
- "START",
- "CENTER",
- "END",
- "JUSTIFIED"
- ],
- "description": "The text alignment for this paragraph.",
- "type": "string"
- },
- "spaceBelow": {
- "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent.",
- "$ref": "Dimension"
- },
- "direction": {
- "enumDescriptions": [
- "The text direction is inherited from the parent.",
- "The text goes from left to right.",
- "The text goes from right to left."
- ],
- "enum": [
- "TEXT_DIRECTION_UNSPECIFIED",
- "LEFT_TO_RIGHT",
- "RIGHT_TO_LEFT"
- ],
- "description": "The text direction of this paragraph. If unset, the value defaults to\nLEFT_TO_RIGHT since\ntext direction is not inherited.",
- "type": "string"
- },
- "indentEnd": {
- "$ref": "Dimension",
- "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."
- },
- "spacingMode": {
- "type": "string",
- "enumDescriptions": [
- "The spacing mode is inherited from the parent.",
- "Paragraph spacing is always rendered.",
- "Paragraph spacing is skipped between list elements."
- ],
- "enum": [
- "SPACING_MODE_UNSPECIFIED",
- "NEVER_COLLAPSE",
- "COLLAPSE_LISTS"
- ],
- "description": "The spacing mode for the paragraph."
- },
- "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": {
- "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent.",
- "$ref": "Dimension"
- }
- },
- "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": {
- "$ref": "TableRowProperties",
- "description": "The table row properties to update."
- },
- "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",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- }
- },
- "id": "UpdateTableRowPropertiesRequest"
- },
- "ReplaceAllShapesWithSheetsChartResponse": {
- "properties": {
- "occurrencesChanged": {
- "description": "The number of shapes replaced with charts.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ReplaceAllShapesWithSheetsChartResponse",
- "description": "The result of replacing shapes with a Google Sheets chart.",
- "type": "object"
- },
- "TableCellProperties": {
- "description": "The properties of the TableCell.",
- "type": "object",
- "properties": {
- "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.",
- "An alignment that aligns the content to the top of the content holder.\nCorresponds to ECMA-376 ST_TextAnchoringType 't'.",
- "An alignment that aligns the content to the middle of the content\nholder. Corresponds to ECMA-376 ST_TextAnchoringType 'ctr'.",
- "An alignment that aligns the content to the bottom of the content\nholder. Corresponds to ECMA-376 ST_TextAnchoringType 'b'."
- ],
- "enum": [
- "CONTENT_ALIGNMENT_UNSPECIFIED",
- "CONTENT_ALIGNMENT_UNSUPPORTED",
- "TOP",
- "MIDDLE",
- "BOTTOM"
- ]
- }
- },
- "id": "TableCellProperties"
- },
- "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": {
- "outlineFill": {
- "$ref": "OutlineFill",
- "description": "The fill of the outline."
- },
- "weight": {
- "$ref": "Dimension",
- "description": "The thickness of the outline."
- },
- "dashStyle": {
- "enumDescriptions": [
- "Unspecified dash style.",
- "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
- "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
- "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
- "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
- "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
- "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
- ],
- "enum": [
- "DASH_STYLE_UNSPECIFIED",
- "SOLID",
- "DOT",
- "DASH",
- "DASH_DOT",
- "LONG_DASH",
- "LONG_DASH_DOT"
- ],
- "description": "The dash style of the outline.",
- "type": "string"
- },
- "propertyState": {
- "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.",
- "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 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."
- }
- },
- "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": {
- "objectId": {
- "type": "string",
- "description": "The object ID of the chart to refresh."
- }
- }
- },
- "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": {
- "$ref": "Link",
- "description": "The hyperlink destination of the shape. If unset, there is no link. Links\nare not inherited from parent placeholders."
- },
- "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"
- },
- "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": [
- "An unspecified content alignment. The content alignment is inherited from\nthe parent if it exists.",
- "An unsupported content alignment.",
- "An alignment that aligns the content to the top of the content holder.\nCorresponds to ECMA-376 ST_TextAnchoringType 't'.",
- "An alignment that aligns the content to the middle of the content\nholder. Corresponds to ECMA-376 ST_TextAnchoringType 'ctr'.",
- "An alignment that aligns the content to the bottom of the content\nholder. Corresponds to ECMA-376 ST_TextAnchoringType 'b'."
- ],
- "enum": [
- "CONTENT_ALIGNMENT_UNSPECIFIED",
- "CONTENT_ALIGNMENT_UNSUPPORTED",
- "TOP",
- "MIDDLE",
- "BOTTOM"
- ],
- "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"
- }
- },
- "id": "ShapeProperties"
- },
- "TableColumnProperties": {
- "description": "Properties of each column in a table.",
- "type": "object",
- "properties": {
- "columnWidth": {
- "description": "Width of a column.",
- "$ref": "Dimension"
- }
- },
- "id": "TableColumnProperties"
- },
- "NotesProperties": {
- "properties": {
- "speakerNotesObjectId": {
- "description": "The object ID of the shape on this notes page that contains the speaker\nnotes for the corresponding slide.\nThe actual shape may not always exist on the notes page. Inserting text\nusing this object ID will automatically create the shape. In this case, the\nactual shape may have different object ID. The `GetPresentation` or\n`GetPage` action will always return the latest object ID.",
- "type": "string"
- }
- },
- "id": "NotesProperties",
- "description": "The properties of Page that are only\nrelevant for pages with page_type NOTES.",
- "type": "object"
- },
- "TableRow": {
- "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."
- },
- "tableCells": {
- "description": "Properties and contents of each cell.\n\nCells that span multiple columns are represented only once with a\ncolumn_span greater\nthan 1. As a result, the length of this collection does not always match\nthe number of columns of the entire table.",
- "type": "array",
- "items": {
- "$ref": "TableCell"
- }
- }
- },
- "id": "TableRow"
- },
- "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"
- },
- "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"
- },
- "tableCellProperties": {
- "description": "The table cell properties to update.",
- "$ref": "TableCellProperties"
- }
- },
- "id": "UpdateTableCellPropertiesRequest"
- },
- "CreateSlideRequest": {
- "description": "Creates a new slide.",
- "type": "object",
- "properties": {
- "insertionIndex": {
- "description": "The optional zero-based index indicating where to insert the slides.\n\nIf you don't specify an index, the new slide is created at the end.",
- "format": "int32",
- "type": "integer"
- },
- "placeholderIdMappings": {
- "description": "An optional list of object ID mappings from the placeholder(s) on the layout to the placeholder(s)\nthat will be created on the new slide from that specified layout. Can only\nbe used when `slide_layout_reference` is specified.",
- "type": "array",
- "items": {
- "$ref": "LayoutPlaceholderIdMapping"
- }
- },
- "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`."
- },
- "objectId": {
- "type": "string",
- "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."
- }
- },
- "id": "CreateSlideRequest"
- },
- "TableRowProperties": {
- "description": "Properties of each row in a table.",
- "type": "object",
- "properties": {
- "minRowHeight": {
- "$ref": "Dimension",
- "description": "Minimum height of the row. The row will be rendered in the Slides editor at\na height equal to or greater than this value in order to show all the text\nin the row's cell(s)."
- }
- },
- "id": "TableRowProperties"
- },
- "BatchUpdatePresentationRequest": {
- "type": "object",
- "properties": {
- "writeControl": {
- "$ref": "WriteControl",
- "description": "Provides control over how write requests are executed."
- },
- "requests": {
- "description": "A list of updates to apply to the presentation.",
- "type": "array",
- "items": {
- "$ref": "Request"
- }
- }
- },
- "id": "BatchUpdatePresentationRequest",
- "description": "Request message for PresentationsService.BatchUpdatePresentation."
- },
- "GroupObjectsResponse": {
- "description": "The result of grouping objects.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created group.",
- "type": "string"
- }
- },
- "id": "GroupObjectsResponse"
- },
- "TextContent": {
- "id": "TextContent",
- "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": {
- "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": {
- "additionalProperties": {
- "$ref": "List"
- },
- "description": "The bulleted lists contained in this text, keyed by list ID.",
- "type": "object"
- }
- }
- },
- "TableBorderCell": {
- "description": "The properties of each border cell.",
- "type": "object",
- "properties": {
- "location": {
- "$ref": "TableCellLocation",
- "description": "The location of the border within the border table."
- },
- "tableBorderProperties": {
- "$ref": "TableBorderProperties",
- "description": "The border properties."
- }
- },
- "id": "TableBorderCell"
- },
- "TableBorderProperties": {
- "description": "The border styling properties of the\nTableBorderCell.",
- "type": "object",
- "properties": {
- "weight": {
- "$ref": "Dimension",
- "description": "The thickness of the border."
- },
- "tableBorderFill": {
- "description": "The fill of the table border.",
- "$ref": "TableBorderFill"
- },
- "dashStyle": {
- "enum": [
- "DASH_STYLE_UNSPECIFIED",
- "SOLID",
- "DOT",
- "DASH",
- "DASH_DOT",
- "LONG_DASH",
- "LONG_DASH_DOT"
- ],
- "description": "The dash style of the border.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified dash style.",
- "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
- "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
- "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
- "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
- "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
- "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
- ]
- }
- },
- "id": "TableBorderProperties"
- },
- "CreateSheetsChartResponse": {
- "description": "The result of creating an embedded Google Sheets chart.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created chart.",
- "type": "string"
- }
- },
- "id": "CreateSheetsChartResponse"
- },
- "WriteControl": {
- "description": "Provides control over how write requests are executed.",
- "type": "object",
- "properties": {
- "requiredRevisionId": {
- "description": "The revision ID of the presentation required for the write request. If\nspecified and the `required_revision_id` doesn't exactly match the\npresentation's current `revision_id`, the request will not be processed and\nwill return a 400 bad request error.",
- "type": "string"
- }
- },
- "id": "WriteControl"
- },
- "DeleteParagraphBulletsRequest": {
- "properties": {
- "objectId": {
- "description": "The object ID of the shape or table containing the text to delete bullets\nfrom.",
- "type": "string"
- },
- "textRange": {
- "description": "The range of text to delete bullets from, based on TextElement indexes.",
- "$ref": "Range"
- },
- "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"
- }
- },
- "id": "DeleteParagraphBulletsRequest",
- "description": "Deletes bullets from all of the paragraphs that overlap with the given text\nindex range.\n\nThe nesting level of each paragraph will be visually preserved by adding\nindent to the start of the corresponding paragraph.",
- "type": "object"
- },
- "ParagraphMarker": {
- "description": "A TextElement kind that represents the beginning of a new paragraph.",
- "type": "object",
- "properties": {
- "style": {
- "$ref": "ParagraphStyle",
- "description": "The paragraph's style"
- },
- "bullet": {
- "$ref": "Bullet",
- "description": "The bullet for this paragraph. If not present, the paragraph does not\nbelong to a list."
- }
- },
- "id": "ParagraphMarker"
- },
- "Thumbnail": {
- "description": "The thumbnail of a page.",
- "type": "object",
- "properties": {
- "width": {
- "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"
- },
- "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"
- }
- },
- "id": "Thumbnail"
- },
- "InsertTableColumnsRequest": {
- "description": "Inserts columns into a table.\n\nOther columns in the table will be resized to fit the new column.",
- "type": "object",
- "properties": {
- "tableObjectId": {
- "description": "The table to insert columns into.",
- "type": "string"
- },
- "number": {
- "description": "The number of columns to be inserted. Maximum 20 per request.",
- "format": "int32",
- "type": "integer"
- },
- "cellLocation": {
- "description": "The reference table cell location from which columns will be inserted.\n\nA new column will be inserted to the left (or right) of the column where\nthe reference cell is. If the reference cell is a merged cell, a new\ncolumn will be inserted to the left (or right) of the merged cell.",
- "$ref": "TableCellLocation"
- },
- "insertRight": {
- "type": "boolean",
- "description": "Whether to insert new columns to the right of the reference cell location.\n\n- `True`: insert to the right.\n- `False`: insert to the left."
- }
- },
- "id": "InsertTableColumnsRequest"
- },
- "LayoutPlaceholderIdMapping": {
- "description": "The user-specified ID mapping for a placeholder that will be created on a\nslide from a specified layout.",
- "type": "object",
- "properties": {
- "layoutPlaceholder": {
- "$ref": "Placeholder",
- "description": "The placeholder on a layout that will be applied to a slide. Only type and index are needed. For example, a\npredefined `TITLE_AND_BODY` layout may usually have a TITLE placeholder\nwith index 0 and a BODY placeholder with index 0."
- },
- "layoutPlaceholderObjectId": {
- "description": "The object ID of the placeholder on a layout that will be applied\nto a slide.",
- "type": "string"
- },
- "objectId": {
- "description": "A user-supplied object ID for the placeholder identified above that to be\ncreated onto a slide.\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"
- }
- },
- "id": "LayoutPlaceholderIdMapping"
- },
- "UpdateTableBorderPropertiesRequest": {
- "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": {
- "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"
- },
- "borderPosition": {
- "type": "string",
- "enumDescriptions": [
- "All borders in the range.",
- "Borders at the bottom of the range.",
- "Borders on the inside of the range.",
- "Horizontal borders on the inside of the range.",
- "Vertical borders on the inside of the range.",
- "Borders at the left of the range.",
- "Borders along the outside of the range.",
- "Borders at the right of the range.",
- "Borders at the top of the range."
- ],
- "enum": [
- "ALL",
- "BOTTOM",
- "INNER",
- "INNER_HORIZONTAL",
- "INNER_VERTICAL",
- "LEFT",
- "OUTER",
- "RIGHT",
- "TOP"
- ],
- "description": "The border position in the table range the updates should apply to. If a\nborder position is not specified, the updates will apply to all borders in\nthe table range."
- },
- "fields": {
- "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"
- }
- },
- "id": "UpdateTableBorderPropertiesRequest"
- },
- "UpdateShapePropertiesRequest": {
- "id": "UpdateShapePropertiesRequest",
- "description": "Update the properties of a Shape.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the shape the updates are applied to.",
- "type": "string"
- },
- "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"
- }
- }
- },
- "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"
- },
- "columnIndices": {
- "description": "The list of zero-based indices specifying which columns to update. If no\nindices are provided, all columns in the table will be updated.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- },
- "tableColumnProperties": {
- "$ref": "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."
- }
- },
- "id": "UpdateTableColumnPropertiesRequest"
- },
- "WordArt": {
- "properties": {
- "renderedText": {
- "description": "The text rendered as word art.",
- "type": "string"
- }
- },
- "id": "WordArt",
- "description": "A PageElement kind representing\nword art.",
- "type": "object"
- },
- "Recolor": {
- "type": "object",
- "properties": {
- "recolorStops": {
- "description": "The recolor effect is represented by a gradient, which is a list of color\nstops.\n\nThe colors in the gradient will replace the corresponding colors at\nthe same position in the color palette and apply to the image. This\nproperty is read-only.",
- "type": "array",
- "items": {
- "$ref": "ColorStop"
- }
- },
- "name": {
- "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.",
- "A recolor effect that lightens the image using the page's second\navailable color from its color scheme.",
- "A recolor effect that lightens the image using the page's third available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's forth available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's fifth available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's sixth available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's seventh\navailable color from its color scheme.e.",
- "A recolor effect that lightens the image using the page's eighth\navailable color from its color scheme.",
- "A recolor effect that lightens the image using the page's ninth available\ncolor from its color scheme.",
- "A recolor effect that lightens the image using the page's tenth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's first available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's second available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's third available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's fourth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's fifth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's sixth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's seventh\navailable color from its color scheme.",
- "A recolor effect that darkens the image using the page's eighth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's ninth available\ncolor from its color scheme.",
- "A recolor effect that darkens the image using the page's tenth available\ncolor from its color scheme.",
- "A recolor effect that recolors the image to grayscale.",
- "A recolor effect that recolors the image to negative grayscale.",
- "A recolor effect that recolors the image using the sepia color.",
- "Custom recolor effect. Refer to `recolor_stops` for the concrete\ngradient."
- ],
- "enum": [
- "NONE",
- "LIGHT1",
- "LIGHT2",
- "LIGHT3",
- "LIGHT4",
- "LIGHT5",
- "LIGHT6",
- "LIGHT7",
- "LIGHT8",
- "LIGHT9",
- "LIGHT10",
- "DARK1",
- "DARK2",
- "DARK3",
- "DARK4",
- "DARK5",
- "DARK6",
- "DARK7",
- "DARK8",
- "DARK9",
- "DARK10",
- "GRAYSCALE",
- "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."
- }
- },
- "id": "Recolor",
- "description": "A recolor effect applied on an image."
- },
- "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"
- },
- "relativeLink": {
- "type": "string",
- "enumDescriptions": [
- "An unspecified relative slide link.",
- "A link to the next slide.",
- "A link to the previous slide.",
- "A link to the first slide in the presentation.",
- "A link to the last slide in the presentation."
- ],
- "enum": [
- "RELATIVE_SLIDE_LINK_UNSPECIFIED",
- "NEXT_SLIDE",
- "PREVIOUS_SLIDE",
- "FIRST_SLIDE",
- "LAST_SLIDE"
- ],
- "description": "If set, indicates this is a link to a slide in this presentation,\naddressed by its position."
- },
- "slideIndex": {
- "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"
- }
- },
- "id": "Link",
- "description": "A hypertext link."
- },
- "CreateShapeResponse": {
- "description": "The result of creating a shape.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created shape.",
- "type": "string"
- }
- },
- "id": "CreateShapeResponse"
- },
- "RgbColor": {
- "description": "An RGB color.",
- "type": "object",
- "properties": {
- "red": {
- "description": "The red component of the color, from 0.0 to 1.0.",
- "format": "float",
- "type": "number"
- },
- "green": {
- "description": "The green component of the color, from 0.0 to 1.0.",
- "format": "float",
- "type": "number"
- },
- "blue": {
- "description": "The blue component of the color, from 0.0 to 1.0.",
- "format": "float",
- "type": "number"
- }
- },
- "id": "RgbColor"
- },
- "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": {
- "description": "The element properties for the line.",
- "$ref": "PageElementProperties"
- },
- "lineCategory": {
- "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.",
- "Curved connectors, including curved connector 2 to 5."
- ],
- "enum": [
- "STRAIGHT",
- "BENT",
- "CURVED"
- ],
- "description": "The category of line to be created.",
- "type": "string"
- }
- },
- "id": "CreateLineRequest"
- },
- "CreateSlideResponse": {
- "description": "The result of creating a slide.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created slide.",
- "type": "string"
- }
- },
- "id": "CreateSlideResponse"
- },
- "CreateShapeRequest": {
- "description": "Creates a new shape.",
- "type": "object",
- "properties": {
- "elementProperties": {
- "description": "The element properties for the shape.",
- "$ref": "PageElementProperties"
- },
- "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.\nIf empty, a unique identifier will be generated.",
- "type": "string"
- },
- "shapeType": {
- "enum": [
- "TYPE_UNSPECIFIED",
- "TEXT_BOX",
- "RECTANGLE",
- "ROUND_RECTANGLE",
- "ELLIPSE",
- "ARC",
- "BENT_ARROW",
- "BENT_UP_ARROW",
- "BEVEL",
- "BLOCK_ARC",
- "BRACE_PAIR",
- "BRACKET_PAIR",
- "CAN",
- "CHEVRON",
- "CHORD",
- "CLOUD",
- "CORNER",
- "CUBE",
- "CURVED_DOWN_ARROW",
- "CURVED_LEFT_ARROW",
- "CURVED_RIGHT_ARROW",
- "CURVED_UP_ARROW",
- "DECAGON",
- "DIAGONAL_STRIPE",
- "DIAMOND",
- "DODECAGON",
- "DONUT",
- "DOUBLE_WAVE",
- "DOWN_ARROW",
- "DOWN_ARROW_CALLOUT",
- "FOLDED_CORNER",
- "FRAME",
- "HALF_FRAME",
- "HEART",
- "HEPTAGON",
- "HEXAGON",
- "HOME_PLATE",
- "HORIZONTAL_SCROLL",
- "IRREGULAR_SEAL_1",
- "IRREGULAR_SEAL_2",
- "LEFT_ARROW",
- "LEFT_ARROW_CALLOUT",
- "LEFT_BRACE",
- "LEFT_BRACKET",
- "LEFT_RIGHT_ARROW",
- "LEFT_RIGHT_ARROW_CALLOUT",
- "LEFT_RIGHT_UP_ARROW",
- "LEFT_UP_ARROW",
- "LIGHTNING_BOLT",
- "MATH_DIVIDE",
- "MATH_EQUAL",
- "MATH_MINUS",
- "MATH_MULTIPLY",
- "MATH_NOT_EQUAL",
- "MATH_PLUS",
- "MOON",
- "NO_SMOKING",
- "NOTCHED_RIGHT_ARROW",
- "OCTAGON",
- "PARALLELOGRAM",
- "PENTAGON",
- "PIE",
- "PLAQUE",
- "PLUS",
- "QUAD_ARROW",
- "QUAD_ARROW_CALLOUT",
- "RIBBON",
- "RIBBON_2",
- "RIGHT_ARROW",
- "RIGHT_ARROW_CALLOUT",
- "RIGHT_BRACE",
- "RIGHT_BRACKET",
- "ROUND_1_RECTANGLE",
- "ROUND_2_DIAGONAL_RECTANGLE",
- "ROUND_2_SAME_RECTANGLE",
- "RIGHT_TRIANGLE",
- "SMILEY_FACE",
- "SNIP_1_RECTANGLE",
- "SNIP_2_DIAGONAL_RECTANGLE",
- "SNIP_2_SAME_RECTANGLE",
- "SNIP_ROUND_RECTANGLE",
- "STAR_10",
- "STAR_12",
- "STAR_16",
- "STAR_24",
- "STAR_32",
- "STAR_4",
- "STAR_5",
- "STAR_6",
- "STAR_7",
- "STAR_8",
- "STRIPED_RIGHT_ARROW",
- "SUN",
- "TRAPEZOID",
- "TRIANGLE",
- "UP_ARROW",
- "UP_ARROW_CALLOUT",
- "UP_DOWN_ARROW",
- "UTURN_ARROW",
- "VERTICAL_SCROLL",
- "WAVE",
- "WEDGE_ELLIPSE_CALLOUT",
- "WEDGE_RECTANGLE_CALLOUT",
- "WEDGE_ROUND_RECTANGLE_CALLOUT",
- "FLOW_CHART_ALTERNATE_PROCESS",
- "FLOW_CHART_COLLATE",
- "FLOW_CHART_CONNECTOR",
- "FLOW_CHART_DECISION",
- "FLOW_CHART_DELAY",
- "FLOW_CHART_DISPLAY",
- "FLOW_CHART_DOCUMENT",
- "FLOW_CHART_EXTRACT",
- "FLOW_CHART_INPUT_OUTPUT",
- "FLOW_CHART_INTERNAL_STORAGE",
- "FLOW_CHART_MAGNETIC_DISK",
- "FLOW_CHART_MAGNETIC_DRUM",
- "FLOW_CHART_MAGNETIC_TAPE",
- "FLOW_CHART_MANUAL_INPUT",
- "FLOW_CHART_MANUAL_OPERATION",
- "FLOW_CHART_MERGE",
- "FLOW_CHART_MULTIDOCUMENT",
- "FLOW_CHART_OFFLINE_STORAGE",
- "FLOW_CHART_OFFPAGE_CONNECTOR",
- "FLOW_CHART_ONLINE_STORAGE",
- "FLOW_CHART_OR",
- "FLOW_CHART_PREDEFINED_PROCESS",
- "FLOW_CHART_PREPARATION",
- "FLOW_CHART_PROCESS",
- "FLOW_CHART_PUNCHED_CARD",
- "FLOW_CHART_PUNCHED_TAPE",
- "FLOW_CHART_SORT",
- "FLOW_CHART_SUMMING_JUNCTION",
- "FLOW_CHART_TERMINATOR",
- "ARROW_EAST",
- "ARROW_NORTH_EAST",
- "ARROW_NORTH",
- "SPEECH",
- "STARBURST",
- "TEARDROP",
- "ELLIPSE_RIBBON",
- "ELLIPSE_RIBBON_2",
- "CLOUD_CALLOUT",
- "CUSTOM"
- ],
- "description": "The shape type.",
"type": "string",
"enumDescriptions": [
"The shape type that is not predefined.",
@@ -3187,744 +2650,267 @@
"Callout cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloudCallout'",
"Custom shape."
]
- }
- },
- "id": "CreateShapeRequest"
- },
- "Video": {
- "description": "A PageElement kind representing a\nvideo.",
- "type": "object",
- "properties": {
- "source": {
- "enum": [
- "SOURCE_UNSPECIFIED",
- "YOUTUBE"
- ],
- "description": "The video source.",
- "type": "string",
- "enumDescriptions": [
- "The video source is unspecified.",
- "The video source is YouTube."
- ]
},
- "url": {
- "description": "An URL to a video. The URL is valid as long as the source video\nexists and sharing settings do not change.",
- "type": "string"
- },
- "id": {
- "type": "string",
- "description": "The video source's unique identifier for this video."
- },
- "videoProperties": {
- "description": "The properties of the video.",
- "$ref": "VideoProperties"
- }
- },
- "id": "Video"
- },
- "PageProperties": {
- "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": {
- "$ref": "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."
- }
- },
- "id": "PageProperties"
- },
- "NestingLevel": {
- "description": "Contains properties describing the look and feel of a list bullet at a given\nlevel of nesting.",
- "type": "object",
- "properties": {
- "bulletStyle": {
- "description": "The style of a bullet at this level of nesting.",
- "$ref": "TextStyle"
- }
- },
- "id": "NestingLevel"
- },
- "TableCell": {
- "description": "Properties and contents of each table cell.",
- "type": "object",
- "properties": {
"text": {
"$ref": "TextContent",
- "description": "The text content of the cell."
+ "description": "The text content of the shape."
},
- "tableCellProperties": {
- "description": "The properties of the table cell.",
- "$ref": "TableCellProperties"
+ "placeholder": {
+ "$ref": "Placeholder",
+ "description": "Placeholders are shapes that are inherit from corresponding placeholders on\nlayouts and masters.\n\nIf set, the shape is a placeholder shape and any inherited properties\ncan be resolved by looking at the parent placeholder identified by the\nPlaceholder.parent_object_id field."
},
- "location": {
- "description": "The location of the cell within the table.",
- "$ref": "TableCellLocation"
- },
- "rowSpan": {
- "description": "Row span of the cell.",
- "format": "int32",
- "type": "integer"
- },
- "columnSpan": {
- "description": "Column span of the cell.",
- "format": "int32",
- "type": "integer"
+ "shapeProperties": {
+ "$ref": "ShapeProperties",
+ "description": "The properties of the shape."
}
},
- "id": "TableCell"
+ "id": "Shape",
+ "description": "A PageElement kind representing a\ngeneric shape that does not have a more specific classification."
},
- "UpdateLinePropertiesRequest": {
+ "Image": {
+ "description": "A PageElement kind representing an\nimage.",
+ "type": "object",
+ "properties": {
+ "contentUrl": {
+ "description": "An URL to an image with 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.",
+ "type": "string"
+ },
+ "imageProperties": {
+ "$ref": "ImageProperties",
+ "description": "The properties of the image."
+ }
+ },
+ "id": "Image"
+ },
+ "InsertTextRequest": {
"type": "object",
"properties": {
"objectId": {
- "description": "The object ID of the line the update is applied to.",
+ "description": "The object ID of the shape or table where the text will be inserted.",
"type": "string"
},
- "lineProperties": {
- "$ref": "LineProperties",
- "description": "The line properties to update."
- },
- "fields": {
- "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",
+ "text": {
+ "description": "The text to be inserted.\n\nInserting a newline character will implicitly create a new\nParagraphMarker at that index.\nThe paragraph style of the new paragraph will be copied from the paragraph\nat the current insertion index, including lists and bullets.\n\nText styles for inserted text will be determined automatically, generally\npreserving the styling of neighboring text. In most cases, the text will be\nadded to the TextRun that exists at the\ninsertion index.\n\nSome control characters (U+0000-U+0008, U+000C-U+001F) and characters\nfrom the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF)\nwill be stripped out of the inserted text.",
"type": "string"
- }
- },
- "id": "UpdateLinePropertiesRequest",
- "description": "Updates the properties of a Line."
- },
- "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.",
+ "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"
},
- "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"
- }
+ "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",
+ "description": "Inserts text into a shape or a table cell."
},
- "TableCellBackgroundFill": {
+ "AffineTransform": {
"type": "object",
"properties": {
- "solidFill": {
- "description": "Solid color fill.",
- "$ref": "SolidFill"
- },
- "propertyState": {
+ "unit": {
+ "enum": [
+ "UNIT_UNSPECIFIED",
+ "EMU",
+ "PT"
+ ],
+ "description": "The units for translate elements.",
"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.",
- "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 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."
- }
- },
- "id": "TableCellBackgroundFill",
- "description": "The table cell background fill."
- },
- "UpdatePagePropertiesRequest": {
- "description": "Updates the properties of a Page.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the page the update is applied to.",
- "type": "string"
- },
- "pageProperties": {
- "$ref": "PageProperties",
- "description": "The page properties to update."
- },
- "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.",
- "type": "object",
- "properties": {
- "children": {
- "description": "The collection of elements in the group. The minimum size of a group is 2.",
- "type": "array",
- "items": {
- "$ref": "PageElement"
- }
- }
- },
- "id": "Group"
- },
- "Placeholder": {
- "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": {
- "type": "integer",
- "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"
- },
- "type": {
- "description": "The type of the placeholder.",
- "type": "string",
- "enumDescriptions": [
- "Default value, signifies it is not a placeholder.",
- "Body text.",
- "Chart or graph.",
- "Clip art image.",
- "Title centered.",
- "Diagram.",
- "Date and time.",
- "Footer text.",
- "Header text.",
- "Multimedia.",
- "Any content type.",
- "Picture.",
- "Number of a slide.",
- "Subtitle.",
- "Table.",
- "Slide title.",
- "Slide image."
- ],
- "enum": [
- "NONE",
- "BODY",
- "CHART",
- "CLIP_ART",
- "CENTERED_TITLE",
- "DIAGRAM",
- "DATE_AND_TIME",
- "FOOTER",
- "HEADER",
- "MEDIA",
- "OBJECT",
- "PICTURE",
- "SLIDE_NUMBER",
- "SUBTITLE",
- "TABLE",
- "TITLE",
- "SLIDE_IMAGE"
- ]
- }
- },
- "id": "Placeholder"
- },
- "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": {
- "objectId": {
- "description": "The ID of the object to duplicate.",
- "type": "string"
- },
- "objectIds": {
- "additionalProperties": {
- "type": "string"
- },
- "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": {
- "id": "ReplaceAllTextRequest",
- "description": "Replaces all instances of text matching a criteria with replace text.",
- "type": "object",
- "properties": {
- "replaceText": {
- "description": "The text that will replace the matched text.",
- "type": "string"
- },
- "pageObjectIds": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "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 master,\nor if a page with that object ID doesn't exist in the presentation."
- },
- "containsText": {
- "$ref": "SubstringMatchCriteria",
- "description": "Finds text in a shape matching this substring."
- }
- }
- },
- "Page": {
- "description": "A page in a presentation.",
- "type": "object",
- "properties": {
- "layoutProperties": {
- "$ref": "LayoutProperties",
- "description": "Layout specific properties. Only set if page_type = LAYOUT."
- },
- "pageElements": {
- "description": "The page elements rendered on the page.",
- "type": "array",
- "items": {
- "$ref": "PageElement"
- }
- },
- "pageType": {
- "enum": [
- "SLIDE",
- "MASTER",
- "LAYOUT",
- "NOTES",
- "NOTES_MASTER"
- ],
- "description": "The type of the page.",
- "type": "string",
- "enumDescriptions": [
- "A slide page.",
- "A master slide page.",
- "A layout page.",
- "A notes page.",
- "A notes master page."
+ "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.",
+ "A point, 1/72 of an inch."
]
},
- "notesProperties": {
- "$ref": "NotesProperties",
- "description": "Notes specific properties. Only set if page_type = NOTES."
- },
- "slideProperties": {
- "description": "Slide specific properties. Only set if page_type = SLIDE.",
- "$ref": "SlideProperties"
- },
- "pageProperties": {
- "description": "The properties of the page.",
- "$ref": "PageProperties"
- },
- "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"
- }
- },
- "id": "Page"
- },
- "UnmergeTableCellsRequest": {
- "description": "Unmerges cells in a Table.",
- "type": "object",
- "properties": {
- "objectId": {
- "type": "string",
- "description": "The object ID of the table."
- },
- "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"
- },
- "ShapeBackgroundFill": {
- "description": "The shape background fill.",
- "type": "object",
- "properties": {
- "solidFill": {
- "description": "Solid color fill.",
- "$ref": "SolidFill"
- },
- "propertyState": {
- "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.",
- "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 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."
- }
- },
- "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": {
- "angle": {
- "description": "The rotation angle of the crop window around its center, in radians.\nRotation angle is applied after the offset.",
- "format": "float",
+ "scaleX": {
+ "description": "The X coordinate scaling element.",
+ "format": "double",
"type": "number"
},
- "topOffset": {
- "description": "The offset specifies the top edge of the crop rectangle that is located\nbelow the original bounding rectangle top edge, relative to the object's\noriginal height.",
- "format": "float",
+ "shearX": {
+ "description": "The X coordinate shearing element.",
+ "format": "double",
"type": "number"
},
- "leftOffset": {
- "description": "The offset specifies the left edge of the crop rectangle that is located to\nthe right of the original bounding rectangle left edge, relative to the\nobject's original width.",
- "format": "float",
+ "scaleY": {
+ "description": "The Y coordinate scaling element.",
+ "format": "double",
"type": "number"
},
- "rightOffset": {
+ "translateY": {
"type": "number",
- "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"
+ "description": "The Y coordinate translation element.",
+ "format": "double"
},
- "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",
+ "translateX": {
+ "description": "The X coordinate translation element.",
+ "format": "double",
+ "type": "number"
+ },
+ "shearY": {
+ "description": "The Y coordinate shearing element.",
+ "format": "double",
"type": "number"
}
},
- "id": "CropProperties"
+ "id": "AffineTransform",
+ "description": "AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ]\nto transform source coordinates (x,y) into destination coordinates (x', y')\naccording to:\n\n x' x = shear_y scale_y translate_y \n 1 [ 1 ]\n\nAfter transformation,\n\n x' = scale_x * x + shear_x * y + translate_x;\n y' = scale_y * y + shear_y * x + translate_y;\n\nThis message is therefore composed of these six matrix elements."
},
- "ReplaceAllShapesWithSheetsChartRequest": {
- "description": "Replaces all shapes that match the given criteria with the provided Google\nSheets chart. The chart will be scaled and centered to fit within the bounds\nof the original shape.\n\nNOTE: Replacing shapes with a chart requires at least one of the\nspreadsheets.readonly, spreadsheets, drive.readonly, or drive OAuth scopes.",
+ "AutoText": {
+ "description": "A TextElement kind that represents auto text.",
"type": "object",
"properties": {
- "spreadsheetId": {
- "description": "The ID of the Google Sheets spreadsheet that contains the chart.",
- "type": "string"
- },
- "linkingMode": {
+ "type": {
+ "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."
+ "An unspecified autotext type.",
+ "Type for autotext that represents the current slide number."
],
"enum": [
- "NOT_LINKED_IMAGE",
- "LINKED"
+ "TYPE_UNSPECIFIED",
+ "SLIDE_NUMBER"
],
- "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"
+ "description": "The type of this auto text."
},
- "containsText": {
- "$ref": "SubstringMatchCriteria",
- "description": "The criteria that the shapes must match in order to be replaced. The\nrequest will replace all of the shapes that contain the given text."
+ "content": {
+ "type": "string",
+ "description": "The rendered content of this auto text, if available."
},
- "chartId": {
- "description": "The ID of the specific chart in the Google Sheets spreadsheet.",
- "format": "int32",
- "type": "integer"
- },
- "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"
- }
+ "style": {
+ "$ref": "TextStyle",
+ "description": "The styling applied to this auto text."
}
},
- "id": "ReplaceAllShapesWithSheetsChartRequest"
+ "id": "AutoText"
},
- "Range": {
- "id": "Range",
- "description": "Specifies a contiguous range of an indexed collection, such as characters in\ntext.",
+ "CreateVideoResponse": {
+ "description": "The result of creating a video.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created video.",
+ "type": "string"
+ }
+ },
+ "id": "CreateVideoResponse"
+ },
+ "DeleteTextRequest": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the shape or table from which the text will be deleted."
+ },
+ "textRange": {
+ "$ref": "Range",
+ "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."
+ }
+ },
+ "id": "DeleteTextRequest",
+ "description": "Deletes text from a shape or a table cell."
+ },
+ "UpdatePageElementTransformRequest": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the page element to update.",
+ "type": "string"
+ },
+ "transform": {
+ "$ref": "AffineTransform",
+ "description": "The input transform matrix used to update the page element."
+ },
+ "applyMode": {
+ "enum": [
+ "APPLY_MODE_UNSPECIFIED",
+ "RELATIVE",
+ "ABSOLUTE"
+ ],
+ "description": "The apply mode of the transform update.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified mode.",
+ "Applies the new AffineTransform matrix to the existing one, and\nreplaces the existing one with the resulting concatenation.",
+ "Replaces the existing AffineTransform matrix with the new one."
+ ]
+ }
+ },
+ "id": "UpdatePageElementTransformRequest",
+ "description": "Updates the transform of a page element.\n\nUpdating the transform of a group will change the absolute transform of the\npage elements in that group, which can change their visual appearance. See\nthe documentation for PageElement.transform for more details."
+ },
+ "DeleteObjectRequest": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "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."
+ }
+ },
+ "id": "DeleteObjectRequest",
+ "description": "Deletes an object, either pages or\npage elements, from the\npresentation."
+ },
+ "TextElement": {
"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.",
+ "description": "The zero-based start index of this text element, in Unicode code units.",
"format": "int32",
"type": "integer"
},
"endIndex": {
- "description": "The optional zero-based index of the end of the collection.\nRequired for `FIXED_RANGE` ranges.",
+ "description": "The zero-based end index of this text element, exclusive, in Unicode code\nunits.",
"format": "int32",
"type": "integer"
},
- "type": {
- "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.",
- "Starts the range at `start_index` and continues until the\nend of the collection. The `end_index` must not be specified.",
- "Sets the range to be the whole length of the collection. Both the\n`start_index` and the `end_index` must not be\nspecified."
- ],
- "enum": [
- "RANGE_TYPE_UNSPECIFIED",
- "FIXED_RANGE",
- "FROM_START_INDEX",
- "ALL"
- ],
- "description": "The type of range."
+ "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."
}
- }
+ },
+ "id": "TextElement",
+ "description": "A TextElement describes the content of a range of indices in the text content\nof a Shape or TableCell."
},
- "ColorStop": {
- "description": "A color and position in a gradient band.",
+ "Dimension": {
+ "description": "A magnitude in a single direction in the specified units.",
"type": "object",
"properties": {
- "alpha": {
- "description": "The alpha value of this color in the gradient band. Defaults to 1.0,\nfully opaque.",
- "format": "float",
+ "magnitude": {
+ "description": "The magnitude.",
+ "format": "double",
"type": "number"
},
- "position": {
- "type": "number",
- "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"
- },
- "color": {
- "description": "The color of the gradient stop.",
- "$ref": "OpaqueColor"
- }
- },
- "id": "ColorStop"
- },
- "CreateVideoRequest": {
- "description": "Creates a video.",
- "type": "object",
- "properties": {
- "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.",
- "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"
- },
- "source": {
+ "unit": {
+ "enum": [
+ "UNIT_UNSPECIFIED",
+ "EMU",
+ "PT"
+ ],
+ "description": "The units for magnitude.",
"type": "string",
"enumDescriptions": [
- "The video source is unspecified.",
- "The video source is YouTube."
- ],
- "enum": [
- "SOURCE_UNSPECIFIED",
- "YOUTUBE"
- ],
- "description": "The video source."
- },
- "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"
- }
- },
- "id": "CreateVideoRequest"
- },
- "DuplicateObjectResponse": {
- "description": "The response of duplicating an object.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The ID of the new duplicate object.",
- "type": "string"
- }
- },
- "id": "DuplicateObjectResponse"
- },
- "ReplaceAllShapesWithImageRequest": {
- "id": "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": {
- "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"
- ],
- "description": "The replace method.",
- "type": "string"
- },
- "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"
- }
- }
- }
- },
- "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."
- }
- }
- },
- "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": {
- "transform": {
- "$ref": "AffineTransform",
- "description": "Transform that encodes the translate, scale, and skew of the shadow,\nrelative to the alignment position."
- },
- "type": {
- "enumDescriptions": [
- "Unspecified shadow type.",
- "Outer shadow."
- ],
- "enum": [
- "SHADOW_TYPE_UNSPECIFIED",
- "OUTER"
- ],
- "description": "The type of the shadow.",
- "type": "string"
- },
- "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": {
- "$ref": "OpaqueColor",
- "description": "The shadow color value."
- },
- "rotateWithShape": {
- "description": "Whether the shadow should rotate with the shape.",
- "type": "boolean"
- },
- "propertyState": {
- "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",
- "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."
+ "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.",
+ "A point, 1/72 of an inch."
]
- },
- "blurRadius": {
- "$ref": "Dimension",
- "description": "The radius of the shadow blur. The larger the radius, the more diffuse the\nshadow becomes."
}
},
- "id": "Shadow"
+ "id": "Dimension"
},
- "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"
- }
- }
- }
- },
- "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": {
- "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"
- },
- "bulletStyle": {
- "description": "The paragraph specific text style applied to this bullet.",
- "$ref": "TextStyle"
- }
- },
- "id": "Bullet"
- },
- "OutlineFill": {
+ "LineFill": {
+ "description": "The fill of the line.",
"type": "object",
"properties": {
"solidFill": {
@@ -3932,43 +2918,1057 @@
"description": "Solid color fill."
}
},
- "id": "OutlineFill",
- "description": "The fill of the outline."
+ "id": "LineFill"
},
- "TableCellLocation": {
- "description": "A location of a single table cell within a table.",
+ "VideoProperties": {
+ "description": "The properties of the Video.",
"type": "object",
"properties": {
- "rowIndex": {
- "description": "The 0-based row index.",
+ "outline": {
+ "$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": {
+ "description": "Inserts rows into a table.",
+ "type": "object",
+ "properties": {
+ "number": {
+ "description": "The number of rows to be inserted. Maximum 20 per request.",
"format": "int32",
"type": "integer"
},
- "columnIndex": {
- "description": "The 0-based column index.",
+ "cellLocation": {
+ "$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": {
+ "type": "object",
+ "properties": {
+ "masterObjectId": {
+ "description": "The object ID of the master that this layout is based on.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the layout."
+ },
+ "displayName": {
+ "description": "The human-readable name of the layout.",
+ "type": "string"
+ }
+ },
+ "id": "LayoutProperties",
+ "description": "The properties of Page are only\nrelevant for pages with page_type LAYOUT."
+ },
+ "LineProperties": {
+ "type": "object",
+ "properties": {
+ "startArrow": {
+ "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",
+ "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."
+ ]
+ },
+ "endArrow": {
+ "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",
+ "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."
+ ]
+ },
+ "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": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified dash style.",
+ "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
+ "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
+ "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
+ "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
+ "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
+ "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
+ ],
+ "enum": [
+ "DASH_STYLE_UNSPECIFIED",
+ "SOLID",
+ "DOT",
+ "DASH",
+ "DASH_DOT",
+ "LONG_DASH",
+ "LONG_DASH_DOT"
+ ],
+ "description": "The dash style of the line."
+ }
+ },
+ "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."
+ },
+ "Presentation": {
+ "description": "A Google Slides presentation.",
+ "type": "object",
+ "properties": {
+ "presentationId": {
+ "description": "The ID of the presentation.",
+ "type": "string"
+ },
+ "slides": {
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ },
+ "description": "The slides in the presentation.\nA slide inherits properties from a slide layout."
+ },
+ "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."
+ },
+ "title": {
+ "description": "The title of the presentation.",
+ "type": "string"
+ },
+ "layouts": {
+ "description": "The layouts in the presentation. A layout is a template that determines\nhow content is arranged and styled on the slides that inherit from that\nlayout.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ },
+ "masters": {
+ "description": "The slide masters in the presentation. A slide master contains all common\npage elements and the common properties for a set of layouts. They serve\nthree purposes:\n\n- Placeholder shapes on a master contain the default text styles and shape\n properties of all placeholder shapes on pages that use that master.\n- The master page properties define the common page properties inherited by\n its layouts.\n- Any other shapes on the master slide will appear on all slides using that\n master, regardless of their layout.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ },
+ "locale": {
+ "description": "The locale of the presentation, as an IETF BCP 47 language tag.",
+ "type": "string"
+ },
+ "pageSize": {
+ "$ref": "Size",
+ "description": "The size of pages in the presentation."
+ }
+ },
+ "id": "Presentation"
+ },
+ "OpaqueColor": {
+ "description": "A themeable solid color value.",
+ "type": "object",
+ "properties": {
+ "rgbColor": {
+ "$ref": "RgbColor",
+ "description": "An opaque RGB color."
+ },
+ "themeColor": {
+ "enum": [
+ "THEME_COLOR_TYPE_UNSPECIFIED",
+ "DARK1",
+ "LIGHT1",
+ "DARK2",
+ "LIGHT2",
+ "ACCENT1",
+ "ACCENT2",
+ "ACCENT3",
+ "ACCENT4",
+ "ACCENT5",
+ "ACCENT6",
+ "HYPERLINK",
+ "FOLLOWED_HYPERLINK",
+ "TEXT1",
+ "BACKGROUND1",
+ "TEXT2",
+ "BACKGROUND2"
+ ],
+ "description": "An opaque theme color.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified theme color. This value should not be used.",
+ "Represents the first dark color.",
+ "Represents the first light color.",
+ "Represents the second dark color.",
+ "Represents the second light color.",
+ "Represents the first accent color.",
+ "Represents the second accent color.",
+ "Represents the third accent color.",
+ "Represents the fourth accent color.",
+ "Represents the fifth accent color.",
+ "Represents the sixth accent color.",
+ "Represents the color to use for hyperlinks.",
+ "Represents the color to use for visited hyperlinks.",
+ "Represents the first text color.",
+ "Represents the first background color.",
+ "Represents the second text color.",
+ "Represents the second background color."
+ ]
+ }
+ },
+ "id": "OpaqueColor"
+ },
+ "ImageProperties": {
+ "description": "The properties of the Image.",
+ "type": "object",
+ "properties": {
+ "recolor": {
+ "$ref": "Recolor",
+ "description": "The recolor effect of the image. If not set, the image is not recolored.\nThis property is read-only."
+ },
+ "cropProperties": {
+ "$ref": "CropProperties",
+ "description": "The crop properties of the image. If not set, the image is not cropped.\nThis property is read-only."
+ },
+ "outline": {
+ "$ref": "Outline",
+ "description": "The outline of the image. If not set, the image has no 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.",
+ "format": "float",
+ "type": "number"
+ },
+ "transparency": {
+ "description": "The transparency effect of the image. The value should be in the interval\n[0.0, 1.0], where 0 means no effect and 1 means completely transparent.\nThis property is read-only.",
+ "format": "float",
+ "type": "number"
+ },
+ "shadow": {
+ "$ref": "Shadow",
+ "description": "The shadow of the image. If not set, the image has no shadow. This property\nis read-only."
+ },
+ "link": {
+ "$ref": "Link",
+ "description": "The hyperlink destination of the image. If unset, there is no link."
+ },
+ "contrast": {
+ "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"
+ }
+ },
+ "id": "ImageProperties"
+ },
+ "ReplaceAllShapesWithImageResponse": {
+ "type": "object",
+ "properties": {
+ "occurrencesChanged": {
+ "type": "integer",
+ "description": "The number of shapes replaced with images.",
+ "format": "int32"
+ }
+ },
+ "id": "ReplaceAllShapesWithImageResponse",
+ "description": "The result of replacing shapes with an image."
+ },
+ "Line": {
+ "description": "A PageElement kind representing a\nline, curved connector, or bent connector.",
+ "type": "object",
+ "properties": {
+ "lineProperties": {
+ "$ref": "LineProperties",
+ "description": "The properties of the line."
+ },
+ "lineType": {
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified line type.",
+ "Straight connector 1 form. Corresponds to ECMA-376 ST_ShapeType\n'straightConnector1'.",
+ "Bent connector 2 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector2'.",
+ "Bent connector 3 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector3'.",
+ "Bent connector 4 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector4'.",
+ "Bent connector 5 form. Corresponds to ECMA-376 ST_ShapeType\n'bentConnector5'.",
+ "Curved connector 2 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector2'.",
+ "Curved connector 3 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector3'.",
+ "Curved connector 4 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector4'.",
+ "Curved connector 5 form. Corresponds to ECMA-376 ST_ShapeType\n'curvedConnector5'."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "STRAIGHT_CONNECTOR_1",
+ "BENT_CONNECTOR_2",
+ "BENT_CONNECTOR_3",
+ "BENT_CONNECTOR_4",
+ "BENT_CONNECTOR_5",
+ "CURVED_CONNECTOR_2",
+ "CURVED_CONNECTOR_3",
+ "CURVED_CONNECTOR_4",
+ "CURVED_CONNECTOR_5"
+ ],
+ "description": "The type of the line."
+ }
+ },
+ "id": "Line"
+ },
+ "CreateSheetsChartRequest": {
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "elementProperties": {
+ "$ref": "PageElementProperties",
+ "description": "The element properties for the chart.\n\nWhen the aspect ratio of the provided size does not match the chart aspect\nratio, the chart is scaled and centered with respect to the size in order\nto maintain aspect ratio. The provided transform is applied after this\noperation."
+ },
+ "spreadsheetId": {
+ "description": "The ID of the Google Sheets spreadsheet that contains the chart.",
+ "type": "string"
+ },
+ "linkingMode": {
+ "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",
+ "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."
+ ]
+ },
+ "chartId": {
+ "type": "integer",
+ "description": "The ID of the specific chart in the Google Sheets spreadsheet.",
+ "format": "int32"
+ }
+ },
+ "id": "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."
+ },
+ "BatchUpdatePresentationResponse": {
+ "type": "object",
+ "properties": {
+ "replies": {
+ "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."
+ },
+ "presentationId": {
+ "type": "string",
+ "description": "The presentation the updates were applied to."
+ }
+ },
+ "id": "BatchUpdatePresentationResponse",
+ "description": "Response message from a batch update."
+ },
+ "CreateImageResponse": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the created image.",
+ "type": "string"
+ }
+ },
+ "id": "CreateImageResponse",
+ "description": "The result of creating an image."
+ },
+ "SlideProperties": {
+ "description": "The properties of Page that are only\nrelevant for pages with page_type SLIDE.",
+ "type": "object",
+ "properties": {
+ "layoutObjectId": {
+ "type": "string",
+ "description": "The object ID of the layout that this slide is based on."
+ },
+ "masterObjectId": {
+ "description": "The object ID of the master that this slide is based on.",
+ "type": "string"
+ },
+ "notesPage": {
+ "$ref": "Page",
+ "description": "The notes page that this slide is associated with. It defines the visual\nappearance of a notes page when printing or exporting slides with speaker\nnotes. A notes page inherits properties from the\nnotes master.\nThe placeholder shape with type BODY on the notes page contains the speaker\nnotes for this slide. The ID of this shape is identified by the\nspeakerNotesObjectId field.\nThe notes page is read-only except for the text content and styles of the\nspeaker notes shape."
+ }
+ },
+ "id": "SlideProperties"
+ },
+ "MasterProperties": {
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "The human-readable name of the master.",
+ "type": "string"
+ }
+ },
+ "id": "MasterProperties",
+ "description": "The properties of Page that are only\nrelevant for pages with page_type MASTER."
+ },
+ "Response": {
+ "description": "A single response from an update.",
+ "type": "object",
+ "properties": {
+ "createShape": {
+ "$ref": "CreateShapeResponse",
+ "description": "The result of creating a shape."
+ },
+ "replaceAllShapesWithImage": {
+ "$ref": "ReplaceAllShapesWithImageResponse",
+ "description": "The result of replacing all shapes matching some criteria with an\nimage."
+ },
+ "createTable": {
+ "$ref": "CreateTableResponse",
+ "description": "The result of creating a table."
+ },
+ "replaceAllText": {
+ "$ref": "ReplaceAllTextResponse",
+ "description": "The result of replacing text."
+ },
+ "createSlide": {
+ "$ref": "CreateSlideResponse",
+ "description": "The result of creating a slide."
+ },
+ "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": {
+ "$ref": "CreateVideoResponse",
+ "description": "The result of creating a video."
+ },
+ "createSheetsChart": {
+ "$ref": "CreateSheetsChartResponse",
+ "description": "The result of creating a Google Sheets chart."
+ },
+ "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."
+ }
+ },
+ "id": "Response"
+ },
+ "SubstringMatchCriteria": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string",
+ "description": "The text to search for in the shape or table."
+ },
+ "matchCase": {
+ "type": "boolean",
+ "description": "Indicates whether the search should respect case:\n\n- `True`: the search is case sensitive.\n- `False`: the search is case insensitive."
+ }
+ },
+ "id": "SubstringMatchCriteria",
+ "description": "A criteria that matches a specific string of text in a shape or table."
+ },
+ "LayoutReference": {
+ "type": "object",
+ "properties": {
+ "layoutId": {
+ "type": "string",
+ "description": "Layout ID: the object ID of one of the layouts in the presentation."
+ },
+ "predefinedLayout": {
+ "enum": [
+ "PREDEFINED_LAYOUT_UNSPECIFIED",
+ "BLANK",
+ "CAPTION_ONLY",
+ "TITLE",
+ "TITLE_AND_BODY",
+ "TITLE_AND_TWO_COLUMNS",
+ "TITLE_ONLY",
+ "SECTION_HEADER",
+ "SECTION_TITLE_AND_DESCRIPTION",
+ "ONE_COLUMN_TEXT",
+ "MAIN_POINT",
+ "BIG_NUMBER"
+ ],
+ "description": "Predefined layout.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified layout.",
+ "Blank layout, with no placeholders.",
+ "Layout with a caption at the bottom.",
+ "Layout with a title and a subtitle.",
+ "Layout with a title and body.",
+ "Layout with a title and two columns.",
+ "Layout with only a title.",
+ "Layout with a section title.",
+ "Layout with a title and subtitle on one side and description on the other.",
+ "Layout with one title and one body, arranged in a single column.",
+ "Layout with a main point.",
+ "Layout with a big number heading."
+ ]
+ }
+ },
+ "id": "LayoutReference",
+ "description": "Slide layout reference. This may reference either:\n\n- A predefined layout\n- One of the layouts in the presentation."
+ },
+ "TextRun": {
+ "description": "A TextElement kind that represents a run of text that all has the same\nstyling.",
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The text of this run."
+ },
+ "style": {
+ "$ref": "TextStyle",
+ "description": "The styling applied to this run."
+ }
+ },
+ "id": "TextRun"
+ },
+ "TableRange": {
+ "description": "A table range represents a reference to a subset of a table.\n\nIt's important to note that the cells specified by a table range do not\nnecessarily form a rectangle. For example, let's say we have a 3 x 3 table\nwhere all the cells of the last row are merged together. The table looks\nlike this:\n\n \n [ ]\n\nA table range with location = (0, 0), row span = 3 and column span = 2\nspecifies the following cells:\n\n x x \n [ x ]",
+ "type": "object",
+ "properties": {
+ "location": {
+ "$ref": "TableCellLocation",
+ "description": "The starting location of the table range."
+ },
+ "rowSpan": {
+ "description": "The row span of the table range.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "columnSpan": {
+ "type": "integer",
+ "description": "The column span of the table range.",
+ "format": "int32"
+ }
+ },
+ "id": "TableRange"
+ },
+ "CreateTableRequest": {
+ "description": "Creates a new table.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "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."
+ },
+ "columns": {
+ "type": "integer",
+ "description": "Number of columns in the table.",
+ "format": "int32"
+ },
+ "elementProperties": {
+ "$ref": "PageElementProperties",
+ "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."
+ },
+ "rows": {
+ "type": "integer",
+ "description": "Number of rows in the table.",
+ "format": "int32"
+ }
+ },
+ "id": "CreateTableRequest"
+ },
+ "CreateTableResponse": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the created table."
+ }
+ },
+ "id": "CreateTableResponse",
+ "description": "The result of creating a table."
+ },
+ "Table": {
+ "description": "A PageElement kind representing a\ntable.",
+ "type": "object",
+ "properties": {
+ "columns": {
+ "description": "Number of columns in the table.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "tableRows": {
+ "type": "array",
+ "items": {
+ "$ref": "TableRow"
+ },
+ "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."
+ },
+ "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",
+ "items": {
+ "$ref": "TableBorderRow"
+ }
+ },
+ "verticalBorderRows": {
+ "description": "Properties of vertical cell borders.\n\nA table's vertical cell borders are represented as a grid. The grid has the\nsame number of rows as the table and one more column than the number of\ncolumns in the table. For example, if the table is 3 x 3, its vertical\nborders will be represented as a grid with 3 rows and 4 columns.",
+ "type": "array",
+ "items": {
+ "$ref": "TableBorderRow"
+ }
+ },
+ "rows": {
+ "description": "Number of rows in the table.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "tableColumns": {
+ "type": "array",
+ "items": {
+ "$ref": "TableColumnProperties"
+ },
+ "description": "Properties of each column."
+ }
+ },
+ "id": "Table"
+ },
+ "GroupObjectsRequest": {
+ "description": "Groups objects to create an object group. For example, groups PageElements to create a Group on the same page as all the children.",
+ "type": "object",
+ "properties": {
+ "groupObjectId": {
+ "type": "string",
+ "description": "A user-supplied object ID for the group to be created.\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."
+ },
+ "childrenObjectIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The object IDs of the objects to group.\n\nOnly page elements can be grouped. There should be at least two page\nelements on the same page that are not already in another group. Some page\nelements, such as videos, tables and placeholder shapes cannot be grouped."
+ }
+ },
+ "id": "GroupObjectsRequest"
+ },
+ "TableBorderRow": {
+ "description": "Contents of each border row in a table.",
+ "type": "object",
+ "properties": {
+ "tableBorderCells": {
+ "type": "array",
+ "items": {
+ "$ref": "TableBorderCell"
+ },
+ "description": "Properties of each border cell. When a border's adjacent table cells are\nmerged, it is not included in the response."
+ }
+ },
+ "id": "TableBorderRow"
+ },
+ "PageBackgroundFill": {
+ "description": "The page background fill.",
+ "type": "object",
+ "properties": {
+ "stretchedPictureFill": {
+ "$ref": "StretchedPictureFill",
+ "description": "Stretched picture fill."
+ },
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
+ },
+ "propertyState": {
+ "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.",
+ "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 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."
+ }
+ },
+ "id": "PageBackgroundFill"
+ },
+ "SheetsChart": {
+ "description": "A PageElement kind representing\na linked chart embedded from Google Sheets.",
+ "type": "object",
+ "properties": {
+ "sheetsChartProperties": {
+ "$ref": "SheetsChartProperties",
+ "description": "The properties of the Sheets chart."
+ },
+ "contentUrl": {
+ "type": "string",
+ "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."
+ },
+ "spreadsheetId": {
+ "description": "The ID of the Google Sheets spreadsheet that contains the source chart.",
+ "type": "string"
+ },
+ "chartId": {
+ "description": "The ID of the specific chart in the Google Sheets spreadsheet that is\nembedded.",
"format": "int32",
"type": "integer"
}
},
- "id": "TableCellLocation"
+ "id": "SheetsChart"
},
- "CreateLineResponse": {
- "id": "CreateLineResponse",
- "description": "The result of creating a line.",
+ "SolidFill": {
+ "type": "object",
+ "properties": {
+ "alpha": {
+ "type": "number",
+ "description": "The fraction of this `color` that should be applied to the pixel.\nThat is, the final pixel color is defined by the equation:\n\n pixel color = alpha * (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.",
+ "format": "float"
+ },
+ "color": {
+ "$ref": "OpaqueColor",
+ "description": "The color value of the solid fill."
+ }
+ },
+ "id": "SolidFill",
+ "description": "A solid color fill. The page or page element is filled entirely with the\nspecified color value.\n\nIf any field is unset, its value may be inherited from a parent placeholder\nif it exists."
+ },
+ "ThemeColorPair": {
+ "description": "A pair mapping a theme color type to the concrete color it represents.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified theme color. This value should not be used.",
+ "Represents the first dark color.",
+ "Represents the first light color.",
+ "Represents the second dark color.",
+ "Represents the second light color.",
+ "Represents the first accent color.",
+ "Represents the second accent color.",
+ "Represents the third accent color.",
+ "Represents the fourth accent color.",
+ "Represents the fifth accent color.",
+ "Represents the sixth accent color.",
+ "Represents the color to use for hyperlinks.",
+ "Represents the color to use for visited hyperlinks.",
+ "Represents the first text color.",
+ "Represents the first background color.",
+ "Represents the second text color.",
+ "Represents the second background color."
+ ],
+ "enum": [
+ "THEME_COLOR_TYPE_UNSPECIFIED",
+ "DARK1",
+ "LIGHT1",
+ "DARK2",
+ "LIGHT2",
+ "ACCENT1",
+ "ACCENT2",
+ "ACCENT3",
+ "ACCENT4",
+ "ACCENT5",
+ "ACCENT6",
+ "HYPERLINK",
+ "FOLLOWED_HYPERLINK",
+ "TEXT1",
+ "BACKGROUND1",
+ "TEXT2",
+ "BACKGROUND2"
+ ],
+ "description": "The type of the theme color."
+ },
+ "color": {
+ "$ref": "RgbColor",
+ "description": "The concrete color corresponding to the theme color type above."
+ }
+ },
+ "id": "ThemeColorPair"
+ },
+ "OptionalColor": {
+ "description": "A color that can either be fully opaque or fully transparent.",
+ "type": "object",
+ "properties": {
+ "opaqueColor": {
+ "$ref": "OpaqueColor",
+ "description": "If set, this will be used as an opaque color. If unset, this represents\na transparent color."
+ }
+ },
+ "id": "OptionalColor"
+ },
+ "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": {
+ "transform": {
+ "$ref": "AffineTransform",
+ "description": "The transform for the element."
+ },
+ "pageObjectId": {
+ "description": "The object ID of the page where the element is located.",
+ "type": "string"
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "The size of the element."
+ }
+ },
+ "id": "PageElementProperties"
+ },
+ "SheetsChartProperties": {
+ "type": "object",
+ "properties": {
+ "chartImageProperties": {
+ "$ref": "ImageProperties",
+ "description": "The properties of the embedded chart image."
+ }
+ },
+ "id": "SheetsChartProperties",
+ "description": "The properties of the SheetsChart."
+ },
+ "StretchedPictureFill": {
+ "type": "object",
+ "properties": {
+ "contentUrl": {
+ "description": "Reading the content_url:\n\nAn URL to a picture with a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the picture as the original requester. Access to the\npicture may be lost if the presentation's sharing settings change.\n\nWriting the content_url:\n\nThe picture is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Pictures 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"
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "The original size of the picture fill. This field is read-only."
+ }
+ },
+ "id": "StretchedPictureFill",
+ "description": "The stretched picture fill. The page or page element is filled entirely with\nthe specified picture. The picture is stretched to fit its container."
+ },
+ "UpdateTextStyleRequest": {
+ "type": "object",
+ "properties": {
+ "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": {
+ "$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": {
+ "$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."
+ }
+ },
+ "id": "UpdateTextStyleRequest",
+ "description": "Update the styling of text in a Shape or\nTable."
+ },
+ "DeleteTableColumnRequest": {
+ "type": "object",
+ "properties": {
+ "tableObjectId": {
+ "type": "string",
+ "description": "The table to delete columns from."
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The reference table cell location from which a column will be deleted.\n\nThe column this cell spans will be deleted. If this is a merged cell,\nmultiple columns will be deleted. If no columns remain in the table after\nthis deletion, the whole table is deleted."
+ }
+ },
+ "id": "DeleteTableColumnRequest",
+ "description": "Deletes a column from a table."
+ },
+ "List": {
+ "type": "object",
+ "properties": {
+ "nestingLevel": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "NestingLevel"
+ },
+ "description": "A map of nesting levels to the properties of bullets at the associated\nlevel. A list has at most nine levels of nesting, so the possible values\nfor the keys of this map are 0 through 8, inclusive."
+ },
+ "listId": {
+ "description": "The ID of the list.",
+ "type": "string"
+ }
+ },
+ "id": "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."
+ },
+ "WeightedFontFamily": {
+ "type": "object",
+ "properties": {
+ "fontFamily": {
+ "type": "string",
+ "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`."
+ },
+ "weight": {
+ "description": "The rendered weight of the text. This field can have any value that is a\nmultiple of `100` between `100` and `900`, inclusive. This range\ncorresponds to the numerical values described in the CSS 2.1\nSpecification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness),\nwith non-numerical values disallowed. Weights greater than or equal to\n`700` are considered bold, and weights less than `700`are not bold. The\ndefault value is `400` (\"normal\").",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "WeightedFontFamily",
+ "description": "Represents a font family and weight used to style a TextRun."
+ },
+ "PageElement": {
+ "description": "A visual element rendered on a page.",
"type": "object",
"properties": {
"objectId": {
- "description": "The object ID of the created line.",
+ "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.",
"type": "string"
+ },
+ "transform": {
+ "$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."
+ },
+ "shape": {
+ "$ref": "Shape",
+ "description": "A generic shape."
+ },
+ "line": {
+ "$ref": "Line",
+ "description": "A line page element."
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the page element. Combined with title to display alt\ntext."
+ },
+ "elementGroup": {
+ "$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."
+ },
+ "sheetsChart": {
+ "$ref": "SheetsChart",
+ "description": "A linked chart embedded from Google Sheets. Unlinked charts are\nrepresented as images."
+ },
+ "title": {
+ "type": "string",
+ "description": "The title of the page element. Combined with description to display alt\ntext."
+ },
+ "video": {
+ "$ref": "Video",
+ "description": "A video page element."
+ },
+ "wordArt": {
+ "$ref": "WordArt",
+ "description": "A word art page element."
+ },
+ "table": {
+ "$ref": "Table",
+ "description": "A table page element."
}
- }
+ },
+ "id": "PageElement"
+ },
+ "CreateImageRequest": {
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "type": "string",
+ "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."
+ },
+ "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": {
+ "type": "string",
+ "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."
+ }
+ },
+ "id": "CreateImageRequest",
+ "description": "Creates an image."
}
},
- "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": "Slides",
"auth": {
"oauth2": {
@@ -4007,24 +4007,20 @@
"presentations": {
"methods": {
"get": {
- "flatPath": "v1/presentations/{presentationsId}",
- "path": "v1/presentations/{+presentationId}",
- "id": "slides.presentations.get",
- "description": "Gets the latest version of the specified presentation.",
+ "httpMethod": "GET",
"response": {
"$ref": "Presentation"
},
"parameterOrder": [
"presentationId"
],
- "httpMethod": "GET",
"parameters": {
"presentationId": {
- "description": "The ID of the presentation to retrieve.",
"required": true,
"type": "string",
"pattern": "^[^/]+$",
- "location": "path"
+ "location": "path",
+ "description": "The ID of the presentation to retrieve."
}
},
"scopes": [
@@ -4033,33 +4029,33 @@
"https://www.googleapis.com/auth/drive.readonly",
"https://www.googleapis.com/auth/presentations",
"https://www.googleapis.com/auth/presentations.readonly"
- ]
+ ],
+ "flatPath": "v1/presentations/{presentationsId}",
+ "id": "slides.presentations.get",
+ "path": "v1/presentations/{+presentationId}",
+ "description": "Gets the latest version of the specified presentation."
},
"create": {
+ "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"
},
- "parameterOrder": [],
- "httpMethod": "POST",
+ "parameters": {},
"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",
- "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"
- }
+ ]
},
"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"
@@ -4069,10 +4065,10 @@
},
"parameters": {
"presentationId": {
- "description": "The presentation to apply the updates to.",
"required": true,
"type": "string",
- "location": "path"
+ "location": "path",
+ "description": "The presentation to apply the updates to."
}
},
"scopes": [
@@ -4085,21 +4081,25 @@
],
"flatPath": "v1/presentations/{presentationId}:batchUpdate",
"id": "slides.presentations.batchUpdate",
- "path": "v1/presentations/{presentationId}: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": {
"get": {
- "response": {
- "$ref": "Page"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"presentationId",
"pageObjectId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Page"
+ },
"scopes": [
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file",
@@ -4109,33 +4109,32 @@
],
"parameters": {
"presentationId": {
+ "location": "path",
"description": "The ID of the presentation to retrieve.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"pageObjectId": {
+ "location": "path",
"description": "The object ID of the page to retrieve.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}",
- "path": "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."
},
"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"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"presentationId",
"pageObjectId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Thumbnail"
+ },
"scopes": [
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/drive.file",
@@ -4145,38 +4144,39 @@
],
"parameters": {
"pageObjectId": {
- "location": "path",
- "description": "The object ID of the page whose thumbnail to retrieve.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path",
+ "description": "The object ID of the page whose thumbnail to retrieve."
},
"thumbnailProperties.mimeType": {
+ "type": "string",
"location": "query",
"enum": [
"PNG"
],
- "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"
+ "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."
},
"thumbnailProperties.thumbnailSize": {
+ "type": "string",
"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"
+ "description": "The optional thumbnail image size.\n\nIf you don't specify the size, the server chooses a default size of the\nimage."
},
"presentationId": {
- "location": "path",
- "description": "The ID of the presentation to retrieve.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path",
+ "description": "The ID of the presentation to retrieve."
}
},
"flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail",
+ "id": "slides.presentations.pages.getThumbnail",
"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."
}
}
}
@@ -4184,22 +4184,6 @@
}
},
"parameters": {
- "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": {
"type": "string",
"location": "query",
@@ -4211,18 +4195,17 @@
"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": {
- "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
@@ -4232,7 +4215,8 @@
"enum": [
"1",
"2"
- ]
+ ],
+ "description": "V1 error format."
},
"callback": {
"location": "query",
@@ -4240,6 +4224,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",
@@ -4247,18 +4237,12 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
+ "default": "json"
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"key": {
"location": "query",
@@ -4269,16 +4253,32 @@
"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": {
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth bearer token."
}
},
"version": "v1",
"baseUrl": "https://slides.googleapis.com/",
"servicePath": "",
- "description": "An API for creating and editing Google Slides presentations.",
"kind": "discovery#restDescription",
+ "description": "An API for creating and editing Google Slides presentations.",
"basePath": "",
- "documentationLink": "https://developers.google.com/slides/",
"revision": "20171211",
+ "documentationLink": "https://developers.google.com/slides/",
"id": "slides:v1",
"discoveryVersion": "v1",
"version_module": true
diff --git a/sourcerepo/v1/sourcerepo-api.json b/sourcerepo/v1/sourcerepo-api.json
index 6a3b5e0..c2cb550 100644
--- a/sourcerepo/v1/sourcerepo-api.json
+++ b/sourcerepo/v1/sourcerepo-api.json
@@ -1,277 +1,4 @@
{
- "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"
- },
- "ListReposResponse": {
- "description": "Response for ListRepos. The size is not set in the returned repositories.",
- "type": "object",
- "properties": {
- "repos": {
- "description": "The listed repos.",
- "type": "array",
- "items": {
- "$ref": "Repo"
- }
- },
- "nextPageToken": {
- "description": "If non-empty, additional repositories exist within the project. These\ncan be retrieved by including this value in the next ListReposRequest's\npage_token field.",
- "type": "string"
- }
- },
- "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": {
- "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"
- },
- "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"
- },
- "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"
- },
- "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"
- }
- },
- "exemptedMembers": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "AuditConfig"
- },
- "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"
- },
- "Binding": {
- "description": "Associates `members` with a `role`.",
- "type": "object",
- "properties": {
- "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"
- }
- },
- "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"
- },
- "MirrorConfig": {
- "description": "Configuration to automatically mirror a repository from another\nhosting service, for example GitHub or BitBucket.",
- "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.",
- "type": "string"
- },
- "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"
- },
- "url": {
- "description": "URL of the main repository at the other hosting service.",
- "type": "string"
- }
- },
- "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 `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "Repo": {
- "description": "A repository (or repo) is a Git repository storing versioned source content.",
- "type": "object",
- "properties": {
- "mirrorConfig": {
- "description": "How this repository mirrors a repository managed by another service.\nRead-only field.",
- "$ref": "MirrorConfig"
- },
- "url": {
- "description": "URL to clone the repository from Google Cloud Source Repositories.\nRead-only field.",
- "type": "string"
- },
- "size": {
- "description": "The disk usage of the repo, in bytes. Read-only field. Size is only\nreturned by GetRepo.",
- "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"
- }
- },
- "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 Source Repositories",
- "auth": {
- "oauth2": {
- "scopes": {
- "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"
- },
- "https://www.googleapis.com/auth/source.read_only": {
- "description": "View the contents of your source code repositories"
- }
- }
- }
- },
- "rootUrl": "https://sourcerepo.googleapis.com/",
"ownerDomain": "google.com",
"name": "sourcerepo",
"batchPath": "batch",
@@ -282,121 +9,6 @@
"resources": {
"repos": {
"methods": {
- "getIamPolicy": {
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}: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.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "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": {
- "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"
- }
- }
- },
- "get": {
- "description": "Returns information about a repo.",
- "response": {
- "$ref": "Repo"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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": {
- "name": {
- "description": "The name of the requested repository. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/repos/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}",
- "path": "v1/{+name}",
- "id": "sourcerepo.projects.repos.get"
- },
- "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.",
- "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": "^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}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "sourcerepo.projects.repos.testIamPermissions"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "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/.+$",
- "location": "path"
- }
- },
- "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",
- "description": "Deletes a repo."
- },
"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.",
"httpMethod": "GET",
@@ -408,17 +20,17 @@
},
"parameters": {
"pageSize": {
- "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"
+ "type": "integer",
+ "location": "query"
},
"name": {
+ "location": "path",
"description": "The project ID whose repos should be listed. Values are of the form\n`projects/\u003cproject\u003e`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+$"
},
"pageToken": {
"location": "query",
@@ -497,6 +109,121 @@
"flatPath": "v1/projects/{projectsId}/repos",
"path": "v1/{+parent}/repos",
"id": "sourcerepo.projects.repos.create"
+ },
+ "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",
+ "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": {
+ "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/[^/]+/repos/.+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "sourcerepo.projects.repos.getIamPolicy"
+ },
+ "get": {
+ "response": {
+ "$ref": "Repo"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "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": {
+ "name": {
+ "description": "The name of the requested repository. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/repos/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}",
+ "path": "v1/{+name}",
+ "id": "sourcerepo.projects.repos.get",
+ "description": "Returns information about a repo."
+ },
+ "testIamPermissions": {
+ "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": "^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}: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": "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/.+$",
+ "location": "path"
+ }
+ },
+ "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"
}
}
}
@@ -504,11 +231,32 @@
}
},
"parameters": {
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
+ "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.",
@@ -554,41 +302,20 @@
"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"
},
+ "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": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
}
},
"version": "v1",
@@ -599,5 +326,278 @@
"basePath": "",
"revision": "20171110",
"documentationLink": "https://cloud.google.com/source-repositories/docs/apis",
- "id": "sourcerepo:v1"
+ "id": "sourcerepo: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"
+ },
+ "ListReposResponse": {
+ "description": "Response for ListRepos. The size is not set in the returned repositories.",
+ "type": "object",
+ "properties": {
+ "repos": {
+ "description": "The listed repos.",
+ "type": "array",
+ "items": {
+ "$ref": "Repo"
+ }
+ },
+ "nextPageToken": {
+ "description": "If non-empty, additional repositories exist within the project. These\ncan be retrieved by including this value in the next ListReposRequest's\npage_token field.",
+ "type": "string"
+ }
+ },
+ "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.",
+ "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"
+ ]
+ }
+ },
+ "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"
+ },
+ "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": {
+ "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"
+ },
+ "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": "Policy"
+ },
+ "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"
+ }
+ },
+ "exemptedMembers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "AuditConfig"
+ },
+ "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"
+ },
+ "Binding": {
+ "description": "Associates `members` with a `role`.",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ },
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "Repo": {
+ "description": "A repository (or repo) is a Git repository storing versioned source content.",
+ "type": "object",
+ "properties": {
+ "size": {
+ "description": "The disk usage of the repo, in bytes. Read-only field. Size is only\nreturned by GetRepo.",
+ "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"
+ },
+ "mirrorConfig": {
+ "description": "How this repository mirrors a repository managed by another service.\nRead-only field.",
+ "$ref": "MirrorConfig"
+ },
+ "url": {
+ "description": "URL to clone the repository from Google Cloud Source Repositories.\nRead-only field.",
+ "type": "string"
+ }
+ },
+ "id": "Repo"
+ }
+ },
+ "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 Source Repositories",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "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/"
}
diff --git a/spanner/v1/spanner-api.json b/spanner/v1/spanner-api.json
index 6b6cd60..a3fafa2 100644
--- a/spanner/v1/spanner-api.json
+++ b/spanner/v1/spanner-api.json
@@ -5,72 +5,25 @@
"resources": {
"instances": {
"methods": {
- "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 project in which to create the instance. Values\nare of the form `projects/\u003cproject\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances",
- "path": "v1/{+parent}/instances",
- "id": "spanner.projects.instances.create",
- "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.",
- "request": {
- "$ref": "CreateInstanceRequest"
- }
- },
- "setIamPolicy": {
- "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"
- }
- },
- "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"
- }
- },
"getIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}: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.",
@@ -79,20 +32,10 @@
"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}:getIamPolicy",
- "id": "spanner.projects.instances.getIamPolicy",
- "path": "v1/{+resource}: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."
+ }
},
"get": {
+ "description": "Gets information about a particular instance.",
"response": {
"$ref": "Instance"
},
@@ -100,25 +43,28 @@
"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"
],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "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"
- }
- },
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
"path": "v1/{+name}",
- "id": "spanner.projects.instances.get",
- "description": "Gets information about a particular instance."
+ "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"
},
@@ -126,34 +72,28 @@
"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"
],
- "parameters": {
- "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.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path"
- }
- },
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
"path": "v1/{+name}",
- "id": "spanner.projects.instances.patch",
- "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.",
- "request": {
- "$ref": "UpdateInstanceRequest"
- }
+ "id": "spanner.projects.instances.patch"
},
"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"
},
- "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"
},
@@ -161,20 +101,22 @@
"resource"
],
"httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "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"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions"
+ "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/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "spanner.projects.instances.testIamPermissions"
},
"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.",
@@ -185,39 +127,48 @@
"name"
],
"httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "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/[^/]+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
],
- "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"
- }
- },
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
"path": "v1/{+name}",
"id": "spanner.projects.instances.delete"
},
"list": {
+ "flatPath": "v1/projects/{projectsId}/instances",
+ "path": "v1/{+parent}/instances",
+ "id": "spanner.projects.instances.list",
"description": "Lists all instances in the given project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
"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": {
- "pattern": "^projects/[^/]+$",
"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"
+ "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\".",
@@ -225,15 +176,35 @@
"location": "query"
},
"pageToken": {
- "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListInstancesResponse.",
- "type": "string",
- "location": "query"
- },
- "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"
+ "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListInstancesResponse.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ]
+ },
+ "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": [
@@ -241,74 +212,43 @@
"https://www.googleapis.com/auth/spanner.admin"
],
"flatPath": "v1/projects/{projectsId}/instances",
- "id": "spanner.projects.instances.list",
- "path": "v1/{+parent}/instances"
+ "path": "v1/{+parent}/instances",
+ "id": "spanner.projects.instances.create"
+ },
+ "setIamPolicy": {
+ "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",
+ "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."
}
},
"resources": {
"databases": {
"methods": {
- "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"
- },
- "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"
- },
- "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.",
- "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 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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:setIamPolicy"
- },
"getIamPolicy": {
- "path": "v1/{+resource}:getIamPolicy",
- "id": "spanner.projects.instances.databases.getIamPolicy",
"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.",
"request": {
"$ref": "GetIamPolicyRequest"
@@ -333,35 +273,41 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:getIamPolicy"
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "spanner.projects.instances.databases.getIamPolicy"
},
"get": {
- "response": {
- "$ref": "Database"
- },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}",
+ "id": "spanner.projects.instances.databases.get",
+ "path": "v1/{+name}",
+ "description": "Gets the state of a Cloud Spanner database.",
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Database"
+ },
+ "parameters": {
+ "name": {
+ "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/[^/]+$",
+ "location": "path"
+ }
+ },
"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": {
+ "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.",
"response": {
"$ref": "Empty"
},
@@ -381,59 +327,45 @@
"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": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "database": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "Required. The database to update.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl",
- "path": "v1/{+database}/ddl",
- "id": "spanner.projects.instances.databases.updateDdl",
- "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.",
"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"
- },
- "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"
+ "httpMethod": "PATCH",
+ "parameters": {
+ "database": {
+ "description": "Required. The database to update.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
},
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
"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": {
+ "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.",
@@ -443,9 +375,20 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:testIamPermissions"
+ "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",
+ "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."
},
"getDdl": {
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl",
"path": "v1/{+database}/ddl",
"id": "spanner.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.",
@@ -456,24 +399,21 @@
"database"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
"parameters": {
"database": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
"location": "path",
"description": "Required. The database whose schema we wish to get.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ]
},
"list": {
- "path": "v1/{+parent}/databases",
- "id": "spanner.projects.instances.databases.list",
"description": "Lists Cloud Spanner databases.",
"response": {
"$ref": "ListDatabasesResponse"
@@ -482,21 +422,12 @@
"parent"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
"parameters": {
- "pageToken": {
- "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListDatabasesResponse.",
- "type": "string",
- "location": "query"
- },
"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"
+ "type": "integer",
+ "location": "query"
},
"parent": {
"description": "Required. The instance whose databases should be listed.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
@@ -504,69 +435,84 @@
"type": "string",
"pattern": "^projects/[^/]+/instances/[^/]+$",
"location": "path"
+ },
+ "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"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.admin"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases",
+ "path": "v1/{+parent}/databases",
+ "id": "spanner.projects.instances.databases.list"
+ },
+ "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": {
+ "location": "path",
+ "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/[^/]+$"
+ }
+ },
+ "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"
+ }
+ },
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "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",
+ "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."
}
},
"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": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/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}/databases/{databasesId}/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "spanner.projects.instances.databases.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",
- "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"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.databases.operations.delete"
- },
"list": {
- "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.",
"response": {
"$ref": "ListOperationsResponse"
@@ -575,36 +521,38 @@
"name"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
"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": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations$",
"location": "path",
"description": "The name of the operation's parent resource.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/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}/instances/{instancesId}/databases/{databasesId}/operations"
+ "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"
},
"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.",
@@ -615,28 +563,110 @@
"name"
],
"httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "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}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.databases.operations.get"
+ },
+ "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",
"https://www.googleapis.com/auth/spanner.admin"
],
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
"location": "path",
- "description": "The name of the operation resource.",
+ "description": "The name of the operation resource to be cancelled.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$"
}
},
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "spanner.projects.instances.databases.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`.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$"
+ }
+ },
+ "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}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.databases.operations.get"
+ "id": "spanner.projects.instances.databases.operations.delete",
+ "path": "v1/{+name}"
}
}
},
"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.",
+ "response": {
+ "$ref": "Session"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "Required. The name of the session to retrieve.",
+ "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}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.databases.sessions.get"
+ },
"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"
},
@@ -644,10 +674,6 @@
"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 transaction to be committed is running.",
@@ -657,30 +683,26 @@
"location": "path"
}
},
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit",
- "path": "v1/{+session}:commit",
- "id": "spanner.projects.instances.databases.sessions.commit",
- "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.",
- "request": {
- "$ref": "CommitRequest"
- }
- },
- "beginTransaction": {
- "description": "Begins a new transaction. This step can often be skipped:\nRead, ExecuteSql and\nCommit can begin a new transaction as a\nside-effect.",
- "request": {
- "$ref": "BeginTransactionRequest"
- },
- "response": {
- "$ref": "Transaction"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
"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"
+ },
+ "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.",
@@ -690,11 +712,19 @@
"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",
- "path": "v1/{+session}:beginTransaction",
- "id": "spanner.projects.instances.databases.sessions.beginTransaction"
+ "id": "spanner.projects.instances.databases.sessions.beginTransaction",
+ "path": "v1/{+session}:beginTransaction"
},
"executeStreamingSql": {
+ "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.",
+ "request": {
+ "$ref": "ExecuteSqlRequest"
+ },
"response": {
"$ref": "PartialResultSet"
},
@@ -708,24 +738,18 @@
],
"parameters": {
"session": {
+ "location": "path",
"description": "Required. The session in which the SQL query should be performed.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeStreamingSql",
"path": "v1/{+session}:executeStreamingSql",
- "id": "spanner.projects.instances.databases.sessions.executeStreamingSql",
- "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.",
- "request": {
- "$ref": "ExecuteSqlRequest"
- }
+ "id": "spanner.projects.instances.databases.sessions.executeStreamingSql"
},
"delete": {
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.databases.sessions.delete",
"description": "Ends a session, releasing server resources associated with it.",
"response": {
"$ref": "Empty"
@@ -736,24 +760,8 @@
"httpMethod": "DELETE",
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
"description": "Required. The name of the session to delete.",
"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}"
- },
- "executeSql": {
- "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"
@@ -763,37 +771,64 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.data"
],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.databases.sessions.delete"
+ },
+ "executeSql": {
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql",
- "id": "spanner.projects.instances.databases.sessions.executeSql",
"path": "v1/{+session}:executeSql",
+ "id": "spanner.projects.instances.databases.sessions.executeSql",
"request": {
"$ref": "ExecuteSqlRequest"
},
"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.",
- "httpMethod": "POST",
+ "response": {
+ "$ref": "ResultSet"
+ },
"parameterOrder": [
"session"
],
- "response": {
- "$ref": "ResultSet"
- }
+ "httpMethod": "POST",
+ "parameters": {
+ "session": {
+ "location": "path",
+ "description": "Required. The session in which the SQL query should be performed.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ]
},
"list": {
- "description": "Lists all sessions in a given database.",
- "httpMethod": "GET",
- "parameterOrder": [
- "database"
- ],
"response": {
"$ref": "ListSessionsResponse"
},
+ "parameterOrder": [
+ "database"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/spanner.data"
+ ],
"parameters": {
+ "pageSize": {
+ "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",
+ "location": "query"
+ },
"database": {
+ "location": "path",
"description": "Required. The database in which to list sessions.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$"
},
"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\".",
@@ -801,24 +836,15 @@
"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"
+ "description": "If non-empty, `page_token` should contain a\nnext_page_token from a previous\nListSessionsResponse.",
+ "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",
+ "path": "v1/{+database}/sessions",
"id": "spanner.projects.instances.databases.sessions.list",
- "path": "v1/{+database}/sessions"
+ "description": "Lists all sessions in a given database."
},
"streamingRead": {
"request": {
@@ -850,64 +876,71 @@
"id": "spanner.projects.instances.databases.sessions.streamingRead"
},
"rollback": {
- "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 transaction to roll back is running.",
- "required": true,
- "type": "string"
- }
- },
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:rollback",
"path": "v1/{+session}:rollback",
"id": "spanner.projects.instances.databases.sessions.rollback",
- "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`.",
"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"
+ "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"
+ ]
},
"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\"`.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "database"
+ ],
+ "response": {
+ "$ref": "Session"
+ },
+ "parameters": {
+ "database": {
+ "location": "path",
+ "description": "Required. The database in which the new session is created.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.data"
],
- "parameters": {
- "database": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "Required. The database in which the new session is created.",
- "required": true,
- "type": "string"
- }
- },
"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions",
- "path": "v1/{+database}/sessions",
"id": "spanner.projects.instances.databases.sessions.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"
+ "path": "v1/{+database}/sessions"
},
"read": {
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:read",
+ "path": "v1/{+session}:read",
+ "id": "spanner.projects.instances.databases.sessions.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"
},
@@ -927,40 +960,7 @@
"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
"location": "path"
}
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:read",
- "path": "v1/{+session}:read",
- "id": "spanner.projects.instances.databases.sessions.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"
}
- },
- "get": {
- "id": "spanner.projects.instances.databases.sessions.get",
- "path": "v1/{+name}",
- "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}"
}
}
}
@@ -968,33 +968,8 @@
},
"operations": {
"methods": {
- "delete": {
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/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"
@@ -1009,11 +984,11 @@
"type": "string"
},
"name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/operations$",
"location": "path",
"description": "The name of the operation's parent resource.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations$"
},
"pageToken": {
"location": "query",
@@ -1021,10 +996,10 @@
"type": "string"
},
"pageSize": {
- "location": "query",
"description": "The standard list page size.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
}
},
"scopes": [
@@ -1033,38 +1008,35 @@
],
"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."
+ "path": "v1/{+name}"
},
"get": {
- "path": "v1/{+name}",
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
"id": "spanner.projects.instances.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.",
- "response": {
- "$ref": "Operation"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
- "location": "path",
"description": "The name of the operation resource.",
"required": true,
- "type": "string"
+ "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}"
+ ]
},
"cancel": {
- "path": "v1/{+name}:cancel",
- "id": "spanner.projects.instances.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"
@@ -1075,9 +1047,35 @@
"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": {
+ "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"
}
@@ -1086,7 +1084,9 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/spanner.admin"
],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}:cancel"
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.operations.delete"
}
}
}
@@ -1095,9 +1095,6 @@
"instanceConfigs": {
"methods": {
"list": {
- "path": "v1/{+parent}/instanceConfigs",
- "id": "spanner.projects.instanceConfigs.list",
- "description": "Lists the supported instance configurations for a given project.",
"response": {
"$ref": "ListInstanceConfigsResponse"
},
@@ -1110,52 +1107,55 @@
"https://www.googleapis.com/auth/spanner.admin"
],
"parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "If non-empty, `page_token` should contain a\nnext_page_token\nfrom a previous ListInstanceConfigsResponse.",
+ "type": "string"
+ },
+ "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"
- },
- "pageSize": {
- "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",
- "location": "query"
}
},
- "flatPath": "v1/projects/{projectsId}/instanceConfigs"
+ "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": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/spanner.admin"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$",
- "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"
- }
- },
"flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}",
- "path": "v1/{+name}",
"id": "spanner.projects.instanceConfigs.get",
+ "path": "v1/{+name}",
"description": "Gets information about a particular instance configuration.",
- "response": {
- "$ref": "InstanceConfig"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"name"
],
- "httpMethod": "GET"
+ "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"
+ ]
}
}
}
@@ -1163,16 +1163,71 @@
}
},
"parameters": {
+ "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"
+ },
+ "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"
+ },
+ "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": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
@@ -1190,64 +1245,9 @@
"type": "string"
},
"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": {
- "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": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
}
},
"version": "v1",
@@ -1262,384 +1262,6 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "Instance": {
- "id": "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": {
- "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",
- "additionalProperties": {
- "type": "string"
- }
- },
- "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": {
- "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."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "CREATING",
- "READY"
- ]
- },
- "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"
- }
- }
- },
- "ListDatabasesResponse": {
- "id": "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"
- }
- }
- }
- },
- "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"
- },
- "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": {
- "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"
- },
- "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": "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": {
- "id": "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"
- }
- }
- }
- },
- "StructType": {
- "id": "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"
- }
- }
- }
- },
- "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": {
- "$ref": "Type",
- "description": "The type of the field."
- }
- },
- "id": "Field"
- },
- "ResultSetStats": {
- "description": "Additional statistics about a ResultSet or PartialResultSet.",
- "type": "object",
- "properties": {
- "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"
- }
- },
- "queryPlan": {
- "description": "QueryPlan for the query associated with this result.",
- "$ref": "QueryPlan"
- }
- },
- "id": "ResultSetStats"
- },
- "TestIamPermissionsRequest": {
- "id": "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"
- }
- }
- }
- },
- "CommitResponse": {
- "id": "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"
- }
- }
- },
- "Type": {
- "id": "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": {
- "structType": {
- "$ref": "StructType",
- "description": "If code == STRUCT, then `struct_type`\nprovides type information for the struct's fields."
- },
- "arrayElementType": {
- "$ref": "Type",
- "description": "If code == ARRAY, then `array_element_type`\nis the type of the array elements."
- },
- "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"
- ]
- }
- }
- },
- "PlanNode": {
- "id": "PlanNode",
- "description": "Node information for nodes appearing in a QueryPlan.plan_nodes.",
- "type": "object",
- "properties": {
- "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"
- }
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "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"
- },
- "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": {
- "description": "Condensed representation for SCALAR nodes.",
- "$ref": "ShortRepresentation"
- },
- "index": {
- "description": "The `PlanNode`'s index in node list.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "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": {
- "description": "The instance being created.",
- "$ref": "Instance"
- },
- "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": {
- "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"
- },
- "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"
- }
- },
- "id": "ChildLink"
- },
- "Delete": {
- "description": "Arguments to delete operations.",
- "type": "object",
- "properties": {
- "keySet": {
- "$ref": "KeySet",
- "description": "Required. The primary keys of the rows within table to delete."
- },
- "table": {
- "description": "Required. The table whose rows will be deleted.",
- "type": "string"
- }
- },
- "id": "Delete"
- },
"ListInstanceConfigsResponse": {
"description": "The response for ListInstanceConfigs.",
"type": "object",
@@ -1659,15 +1281,15 @@
"id": "ListInstanceConfigsResponse"
},
"BeginTransactionRequest": {
- "id": "BeginTransactionRequest",
"description": "The request for BeginTransaction.",
"type": "object",
"properties": {
"options": {
- "$ref": "TransactionOptions",
- "description": "Required. Options for the new transaction."
+ "description": "Required. Options for the new transaction.",
+ "$ref": "TransactionOptions"
}
- }
+ },
+ "id": "BeginTransactionRequest"
},
"CommitRequest": {
"description": "The request for Commit.",
@@ -1693,7 +1315,6 @@
"id": "CommitRequest"
},
"TestIamPermissionsResponse": {
- "id": "TestIamPermissionsResponse",
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
"properties": {
@@ -1704,7 +1325,8 @@
"type": "string"
}
}
- }
+ },
+ "id": "TestIamPermissionsResponse"
},
"GetIamPolicyRequest": {
"description": "Request message for `GetIamPolicy` method.",
@@ -1713,7 +1335,6 @@
"id": "GetIamPolicyRequest"
},
"CreateDatabaseMetadata": {
- "id": "CreateDatabaseMetadata",
"description": "Metadata type for the operation returned by\nCreateDatabase.",
"type": "object",
"properties": {
@@ -1721,25 +1342,26 @@
"description": "The database being created.",
"type": "string"
}
- }
+ },
+ "id": "CreateDatabaseMetadata"
},
"ListSessionsResponse": {
- "id": "ListSessionsResponse",
"description": "The response for ListSessions.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "`next_page_token` can be sent in a subsequent\nListSessions call to fetch more of the matching\nsessions.",
+ "type": "string"
+ },
"sessions": {
"description": "The list of requested sessions.",
"type": "array",
"items": {
"$ref": "Session"
}
- },
- "nextPageToken": {
- "description": "`next_page_token` can be sent in a subsequent\nListSessions call to fetch more of the matching\nsessions.",
- "type": "string"
}
- }
+ },
+ "id": "ListSessionsResponse"
},
"Session": {
"description": "A session in the Cloud Spanner API.",
@@ -1769,43 +1391,7 @@
},
"id": "Session"
},
- "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`.",
- "type": "array",
- "items": {
- "type": "any"
- }
- },
- "startOpen": {
- "description": "If the start is open, then the range excludes rows whose first\n`len(start_open)` key columns exactly match `start_open`.",
- "type": "array",
- "items": {
- "type": "any"
- }
- },
- "endOpen": {
- "description": "If the end is open, then the range excludes rows whose first\n`len(end_open)` key columns exactly match `end_open`.",
- "type": "array",
- "items": {
- "type": "any"
- }
- },
- "endClosed": {
- "description": "If the end is closed, then the range includes all rows whose\nfirst `len(end_closed)` key columns exactly match `end_closed`.",
- "type": "array",
- "items": {
- "type": "any"
- }
- }
- },
- "id": "KeyRange"
- },
"ListInstancesResponse": {
- "id": "ListInstancesResponse",
"description": "The response for ListInstances.",
"type": "object",
"properties": {
@@ -1820,10 +1406,45 @@
"description": "`next_page_token` can be sent in a subsequent\nListInstances call to fetch more\nof the matching instances.",
"type": "string"
}
- }
+ },
+ "id": "ListInstancesResponse"
+ },
+ "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": {
+ "endOpen": {
+ "description": "If the end is open, then the range excludes rows whose first\n`len(end_open)` key columns exactly match `end_open`.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "endClosed": {
+ "description": "If the end is closed, then the range includes all rows whose\nfirst `len(end_closed)` key columns exactly match `end_closed`.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "startClosed": {
+ "description": "If the start is closed, then the range includes all rows whose\nfirst `len(start_closed)` key columns exactly match `start_closed`.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "startOpen": {
+ "description": "If the start is open, then the range excludes rows whose first\n`len(start_open)` key columns exactly match `start_open`.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ },
+ "id": "KeyRange"
},
"ShortRepresentation": {
- "id": "ShortRepresentation",
"description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).",
"type": "object",
"properties": {
@@ -1832,29 +1453,30 @@
"type": "string"
},
"subqueries": {
- "description": "A mapping of (subquery variable name) -\u003e (subquery node id) for cases\nwhere the `description` string of this node references a `SCALAR`\nsubquery contained in the expression subtree rooted at this node. The\nreferenced `SCALAR` subquery may not necessarily be a direct child of\nthis node.",
- "type": "object",
"additionalProperties": {
"format": "int32",
"type": "integer"
- }
+ },
+ "description": "A mapping of (subquery variable name) -\u003e (subquery node id) for cases\nwhere the `description` string of this node references a `SCALAR`\nsubquery contained in the expression subtree rooted at this node. The\nreferenced `SCALAR` subquery may not necessarily be a direct child of\nthis node.",
+ "type": "object"
}
- }
+ },
+ "id": "ShortRepresentation"
},
"InstanceConfig": {
- "id": "InstanceConfig",
"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"
},
"UpdateInstanceRequest": {
"description": "The request for UpdateInstance.",
@@ -1879,7 +1501,6 @@
"id": "Empty"
},
"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",
"properties": {
@@ -1888,10 +1509,11 @@
"$ref": "ReadWrite"
},
"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."
+ "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"
}
- }
+ },
+ "id": "TransactionOptions"
},
"CreateDatabaseRequest": {
"description": "The request for CreateDatabase.",
@@ -1915,22 +1537,25 @@
"description": "The request for CreateInstance.",
"type": "object",
"properties": {
- "instance": {
- "description": "Required. The instance to create. The name may be omitted, but if\nspecified must be `\u003cparent\u003e/instances/\u003cinstance_id\u003e`.",
- "$ref": "Instance"
- },
"instanceId": {
"description": "Required. The ID of the instance to create. Valid identifiers are of the\nform `a-z*[a-z0-9]` and must be between 6 and 30 characters in\nlength.",
"type": "string"
+ },
+ "instance": {
+ "$ref": "Instance",
+ "description": "Required. The instance to create. The name may be omitted, but if\nspecified must be `\u003cparent\u003e/instances/\u003cinstance_id\u003e`."
}
},
"id": "CreateInstanceRequest"
},
"ReadOnly": {
- "id": "ReadOnly",
"description": "Message type to initiate a read-only transaction.",
"type": "object",
"properties": {
+ "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",
@@ -1954,18 +1579,29 @@
"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"
},
"ExecuteSqlRequest": {
"description": "The request for ExecuteSql and\nExecuteStreamingSql.",
"type": "object",
"properties": {
+ "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"
+ },
"queryMode": {
+ "description": "Used to control the amount of debugging information returned in\nResultSetStats.",
+ "type": "string",
"enumDescriptions": [
"The default mode where only the query result, without any information\nabout the query plan is returned.",
"This mode returns only the query plan, without any result rows or\nexecution statistics information.",
@@ -1975,9 +1611,7 @@
"NORMAL",
"PLAN",
"PROFILE"
- ],
- "description": "Used to control the amount of debugging information returned in\nResultSetStats.",
- "type": "string"
+ ]
},
"transaction": {
"description": "The transaction to use. If none is provided, the default is a\ntemporary read-only transaction with strong concurrency.",
@@ -1994,24 +1628,11 @@
},
"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": {
- "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",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
}
},
"id": "ExecuteSqlRequest"
},
"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": {
@@ -2032,25 +1653,13 @@
"$ref": "Binding"
}
}
- }
+ },
+ "id": "Policy"
},
"ReadRequest": {
"description": "The request for Read and\nStreamingRead.",
"type": "object",
"properties": {
- "limit": {
- "description": "If greater than zero, only the first `limit` rows are yielded. If `limit`\nis zero, the default is no limit.",
- "format": "int64",
- "type": "string"
- },
- "index": {
- "description": "If non-empty, the name of an index on table. This index is\nused instead of the table primary key when interpreting key_set\nand sorting result rows. See key_set for further information.",
- "type": "string"
- },
- "keySet": {
- "$ref": "KeySet",
- "description": "Required. `key_set` identifies the rows to be yielded. `key_set` names the\nprimary keys of the rows in table to be yielded, unless index\nis present. If index is present, then key_set instead names\nindex keys in index.\n\nRows are yielded in table primary key order (if index is empty)\nor index key order (if index is non-empty).\n\nIt is not an error for the `key_set` to name rows that do not\nexist in the database. Read yields nothing for nonexistent rows."
- },
"columns": {
"description": "The columns of table to be returned for each row matching\nthis request.",
"type": "array",
@@ -2070,19 +1679,27 @@
"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",
+ "type": "string"
+ },
+ "index": {
+ "description": "If non-empty, the name of an index on table. This index is\nused instead of the table primary key when interpreting key_set\nand sorting result rows. See key_set for further information.",
+ "type": "string"
+ },
+ "keySet": {
+ "$ref": "KeySet",
+ "description": "Required. `key_set` identifies the rows to be yielded. `key_set` names the\nprimary keys of the rows in table to be yielded, unless index\nis present. If index is present, then key_set instead names\nindex keys in index.\n\nRows are yielded in table primary key order (if index is empty)\nor index key order (if index is non-empty).\n\nIt is not an error for the `key_set` to name rows that do not\nexist in the database. Read yields nothing for nonexistent rows."
}
},
"id": "ReadRequest"
},
"Write": {
- "id": "Write",
"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",
@@ -2099,26 +1716,27 @@
"type": "any"
}
}
+ },
+ "table": {
+ "description": "Required. The table whose rows will be written.",
+ "type": "string"
}
- }
+ },
+ "id": "Write"
},
"ReadWrite": {
- "id": "ReadWrite",
"description": "Message type to initiate a read-write transaction. Currently this\ntransaction type has no options.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "ReadWrite"
},
"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.",
@@ -2139,6 +1757,10 @@
"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"
@@ -2148,50 +1770,46 @@
"type": "object",
"properties": {
"session": {
- "description": "The session to create.",
- "$ref": "Session"
+ "$ref": "Session",
+ "description": "The session to create."
}
},
"id": "CreateSessionRequest"
},
"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"
- }
+ },
+ "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"
},
"ResultSet": {
"description": "Results from Read or\nExecuteSql.",
"type": "object",
"properties": {
- "metadata": {
- "$ref": "ResultSetMetadata",
- "description": "Metadata about the result set, such as row type information."
- },
"stats": {
- "$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."
+ "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"
},
"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.",
@@ -2202,12 +1820,15 @@
"type": "any"
}
}
+ },
+ "metadata": {
+ "description": "Metadata about the result set, such as row type information.",
+ "$ref": "ResultSetMetadata"
}
},
"id": "ResultSet"
},
"Binding": {
- "id": "Binding",
"description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
@@ -2222,31 +1843,46 @@
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
}
- }
+ },
+ "id": "Binding"
},
"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"
},
"PartialResultSet": {
- "id": "PartialResultSet",
"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": {
+ "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": {
+ "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\"`.",
+ "type": "array",
+ "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",
@@ -2255,26 +1891,29 @@
"stats": {
"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."
- },
- "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\"`.",
+ }
+ },
+ "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": {
- "type": "any"
+ "$ref": "Operation"
}
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
- }
+ },
+ "id": "ListOperationsResponse"
},
"UpdateInstanceMetadata": {
- "id": "UpdateInstanceMetadata",
"description": "Metadata type for the operation returned by\nUpdateInstance.",
"type": "object",
"properties": {
@@ -2297,50 +1936,28 @@
"format": "google-datetime",
"type": "string"
}
- }
- },
- "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"
- }
- }
- }
+ },
+ "id": "UpdateInstanceMetadata"
},
"ResultSetMetadata": {
- "id": "ResultSetMetadata",
"description": "Metadata about a ResultSet or PartialResultSet.",
"type": "object",
"properties": {
- "rowType": {
- "$ref": "StructType",
- "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 ]"
- },
"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": {
+ "$ref": "StructType",
+ "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 ]"
}
- }
+ },
+ "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": {
- "id": {
- "description": "Execute the read or SQL query in a previously-started transaction.",
- "format": "byte",
- "type": "string"
- },
"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"
@@ -2348,14 +1965,53 @@
"begin": {
"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.",
"$ref": "TransactionOptions"
+ },
+ "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": {
+ "$ref": "Write",
+ "description": "Insert new rows in a table. If any of the rows already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`."
+ },
+ "insertOrUpdate": {
+ "$ref": "Write",
+ "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."
+ },
+ "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": {
+ "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`.",
+ "$ref": "Write"
+ },
+ "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",
@@ -2369,44 +2025,10 @@
"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"
- },
- "ranges": {
- "description": "A list of key ranges. See KeyRange for more information about\nkey range specifications.",
- "type": "array",
- "items": {
- "$ref": "KeyRange"
- }
}
},
"id": "KeySet"
},
- "Mutation": {
- "id": "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": {
- "replace": {
- "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`.",
- "$ref": "Write"
- },
- "delete": {
- "$ref": "Delete",
- "description": "Delete rows from a table. Succeeds whether or not the named\nrows were present."
- },
- "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"
- }
- }
- },
"GetDatabaseDdlResponse": {
"description": "The response for GetDatabaseDdl.",
"type": "object",
@@ -2445,6 +2067,384 @@
}
},
"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": {
+ "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",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "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": {
+ "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"
+ },
+ "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": "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"
+ },
+ "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": {
+ "description": "Additional statistics about a ResultSet or PartialResultSet.",
+ "type": "object",
+ "properties": {
+ "queryPlan": {
+ "description": "QueryPlan for the query associated with this result.",
+ "$ref": "QueryPlan"
+ },
+ "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"
+ },
+ "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": {
+ "structType": {
+ "$ref": "StructType",
+ "description": "If code == STRUCT, then `struct_type`\nprovides type information for the struct's fields."
+ },
+ "arrayElementType": {
+ "$ref": "Type",
+ "description": "If code == ARRAY, then `array_element_type`\nis the type of the array elements."
+ },
+ "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"
+ ]
+ }
+ },
+ "id": "Type"
+ },
+ "PlanNode": {
+ "description": "Node information for nodes appearing in a QueryPlan.plan_nodes.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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": {
+ "description": "The instance being created.",
+ "$ref": "Instance"
+ },
+ "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",
+ "properties": {
+ "table": {
+ "description": "Required. The table whose rows will be deleted.",
+ "type": "string"
+ },
+ "keySet": {
+ "description": "Required. The primary keys of the rows within table to delete.",
+ "$ref": "KeySet"
+ }
+ },
+ "id": "Delete"
}
},
"icons": {
diff --git a/speech/v1/speech-api.json b/speech/v1/speech-api.json
index 798624b..8a4ce0e 100644
--- a/speech/v1/speech-api.json
+++ b/speech/v1/speech-api.json
@@ -1,15 +1,47 @@
{
- "basePath": "",
- "id": "speech:v1",
- "revision": "20171213",
- "documentationLink": "https://cloud.google.com/speech/",
- "discoveryVersion": "v1",
- "version_module": true,
"schemas": {
- "RecognitionConfig": {
- "description": "Provides information to the recognizer that specifies how to process the\nrequest.",
- "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": "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",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
+ },
+ "RecognitionConfig": {
+ "properties": {
+ "sampleRateHertz": {
+ "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"
+ },
"enableWordTimeOffsets": {
"description": "*Optional* If `true`, the top result includes a list of words and\nthe start and end time offsets (timestamps) for those words. If\n`false`, no word-level time offset information is returned. The default is\n`false`.",
"type": "boolean"
@@ -28,16 +60,6 @@
"type": "boolean"
},
"encoding": {
- "enumDescriptions": [
- "Not specified. Will return result google.rpc.Code.INVALID_ARGUMENT.",
- "Uncompressed 16-bit signed little-endian samples (Linear PCM).",
- "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio\nCodec) is the recommended encoding because it is\nlossless--therefore recognition is not compromised--and\nrequires only about half the bandwidth of `LINEAR16`. `FLAC` stream\nencoding supports 16-bit and 24-bit samples, however, not all fields in\n`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_hertz` must be 8000.",
- "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.",
- "Opus encoded audio frames in Ogg container\n([OggOpus](https://wiki.xiph.org/OggOpus)).\n`sample_rate_hertz` must be 16000.",
- "Although the use of lossy encodings is not recommended, if a very low\nbitrate encoding is required, `OGG_OPUS` is highly preferred over\nSpeex encoding. The [Speex](https://speex.org/) encoding supported by\nCloud Speech API has a header byte in each block, as in MIME type\n`audio/x-speex-with-header-byte`.\nIt is a variant of the RTP Speex encoding defined in\n[RFC 5574](https://tools.ietf.org/html/rfc5574).\nThe stream is a sequence of blocks, one block per RTP packet. Each block\nstarts with a byte containing the length of the block, in bytes, followed\nby one or more frames of Speex data, padded to an integral number of\nbytes (octets) as specified in RFC 5574. In other words, each RTP header\nis replaced with a single byte containing the block length. Only Speex\nwideband is supported. `sample_rate_hertz` must be 16000."
- ],
"enum": [
"ENCODING_UNSPECIFIED",
"LINEAR16",
@@ -49,7 +71,17 @@
"SPEEX_WITH_HEADER_BYTE"
],
"description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. Will return result google.rpc.Code.INVALID_ARGUMENT.",
+ "Uncompressed 16-bit signed little-endian samples (Linear PCM).",
+ "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio\nCodec) is the recommended encoding because it is\nlossless--therefore recognition is not compromised--and\nrequires only about half the bandwidth of `LINEAR16`. `FLAC` stream\nencoding supports 16-bit and 24-bit samples, however, not all fields in\n`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_hertz` must be 8000.",
+ "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.",
+ "Opus encoded audio frames in Ogg container\n([OggOpus](https://wiki.xiph.org/OggOpus)).\n`sample_rate_hertz` must be 16000.",
+ "Although the use of lossy encodings is not recommended, if a very low\nbitrate encoding is required, `OGG_OPUS` is highly preferred over\nSpeex encoding. The [Speex](https://speex.org/) encoding supported by\nCloud Speech API has a header byte in each block, as in MIME type\n`audio/x-speex-with-header-byte`.\nIt is a variant of the RTP Speex encoding defined in\n[RFC 5574](https://tools.ietf.org/html/rfc5574).\nThe stream is a sequence of blocks, one block per RTP packet. Each block\nstarts with a byte containing the length of the block, in bytes, followed\nby one or more frames of Speex data, padded to an integral number of\nbytes (octets) as specified in RFC 5574. In other words, each RTP header\nis replaced with a single byte containing the block length. Only Speex\nwideband is supported. `sample_rate_hertz` must be 16000."
+ ]
},
"speechContexts": {
"description": "*Optional* A means to provide context to assist the speech recognition.",
@@ -57,21 +89,14 @@
"items": {
"$ref": "SpeechContext"
}
- },
- "sampleRateHertz": {
- "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"
}
},
- "id": "RecognitionConfig"
+ "id": "RecognitionConfig",
+ "description": "Provides information to the recognizer that specifies how to process the\nrequest.",
+ "type": "object"
},
"WordInfo": {
"properties": {
- "word": {
- "description": "*Output-only* The word corresponding to this set of information.",
- "type": "string"
- },
"endTime": {
"description": "*Output-only* Time offset relative to the beginning of the audio,\nand corresponding to the end 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.",
"format": "google-duration",
@@ -81,6 +106,10 @@
"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.",
"format": "google-duration",
"type": "string"
+ },
+ "word": {
+ "description": "*Output-only* The word corresponding to this set of information.",
+ "type": "string"
}
},
"id": "WordInfo",
@@ -91,6 +120,15 @@
"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",
@@ -101,15 +139,6 @@
},
"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"
@@ -123,18 +152,50 @@
"RecognizeRequest": {
"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": {
- "description": "*Required* The audio data to be recognized.",
- "$ref": "RecognitionAudio"
+ "$ref": "RecognitionAudio",
+ "description": "*Required* The audio data to be recognized."
}
},
"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"
+ },
+ "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"
+ },
"SpeechRecognitionAlternative": {
"description": "Alternative hypotheses (a.k.a. n-best list).",
"type": "object",
@@ -158,38 +219,6 @@
},
"id": "SpeechRecognitionAlternative"
},
- "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"
- },
- "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"
- },
"SpeechRecognitionResult": {
"description": "A speech recognition result corresponding to a portion of the audio.",
"type": "object",
@@ -230,8 +259,8 @@
"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",
@@ -241,6 +270,8 @@
"id": "LongRunningRecognizeRequest"
},
"RecognizeResponse": {
+ "description": "The only message returned to the client by the `Recognize` 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.",
@@ -250,57 +281,20 @@
}
}
},
- "id": "RecognizeResponse",
- "description": "The only message returned to the client by the `Recognize` method. It\ncontains the result as zero or more sequential `SpeechRecognitionResult`\nmessages.",
- "type": "object"
+ "id": "RecognizeResponse"
},
"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"
}
},
- "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": "Speech",
"auth": {
"oauth2": {
@@ -320,97 +314,45 @@
"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`.",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "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"
- },
- "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": {
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string",
- "pattern": "^[^/]+$"
- }
- },
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/operations/{+name}",
- "id": "speech.operations.delete"
- },
"list": {
- "id": "speech.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": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"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": {
- "location": "query",
"description": "The standard list page token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"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": "v1/operations"
+ "flatPath": "v1/operations",
+ "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."
},
"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"
},
@@ -432,18 +374,66 @@
],
"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."
+ "id": "speech.operations.get"
+ },
+ "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",
+ "id": "speech.operations.cancel",
+ "path": "v1/operations/{+name}:cancel"
+ },
+ "delete": {
+ "flatPath": "v1/operations/{operationsId}",
+ "path": "v1/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",
+ "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"
+ }
+ }
}
}
},
"speech": {
"methods": {
"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": {
@@ -455,15 +445,13 @@
],
"flatPath": "v1/speech:longrunningrecognize",
"id": "speech.speech.longrunningrecognize",
- "path": "v1/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."
},
"recognize": {
- "path": "v1/speech:recognize",
- "id": "speech.speech.recognize",
- "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.",
- "request": {
- "$ref": "RecognizeRequest"
- },
"response": {
"$ref": "RecognizeResponse"
},
@@ -473,89 +461,47 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {},
- "flatPath": "v1/speech:recognize"
+ "flatPath": "v1/speech:recognize",
+ "path": "v1/speech:recognize",
+ "id": "speech.speech.recognize",
+ "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.",
+ "request": {
+ "$ref": "RecognizeRequest"
+ }
}
}
}
},
"parameters": {
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
+ "uploadType": {
"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": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"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": {
- "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"
- },
"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": {
- "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"
},
"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": [
@@ -563,12 +509,66 @@
"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": {
+ "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"
}
},
"version": "v1",
"baseUrl": "https://speech.googleapis.com/",
+ "servicePath": "",
"kind": "discovery#restDescription",
"description": "Converts audio to text by applying powerful neural network models.",
- "servicePath": ""
+ "basePath": "",
+ "revision": "20171213",
+ "documentationLink": "https://cloud.google.com/speech/",
+ "id": "speech:v1",
+ "discoveryVersion": "v1",
+ "version_module": true
}
diff --git a/speech/v1beta1/speech-api.json b/speech/v1beta1/speech-api.json
index d7be78a..ed297c2 100644
--- a/speech/v1beta1/speech-api.json
+++ b/speech/v1beta1/speech-api.json
@@ -2,38 +2,88 @@
"resources": {
"operations": {
"methods": {
+ "cancel": {
+ "id": "speech.operations.cancel",
+ "path": "v1beta1/operations/{+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`.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/operations/{operationsId}:cancel"
+ },
+ "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",
+ "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": "v1beta1/operations/{operationsId}"
+ },
"list": {
"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": {
"description": "The standard list filter.",
"type": "string",
"location": "query"
},
"name": {
+ "location": "query",
"description": "The name of the operation's parent resource.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageToken": {
+ "location": "query",
"description": "The standard list page token.",
- "type": "string",
+ "type": "string"
+ },
+ "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",
@@ -50,11 +100,11 @@
"httpMethod": "GET",
"parameters": {
"name": {
- "pattern": "^[^/]+$",
- "location": "path",
"description": "The name of the operation resource.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -63,78 +113,28 @@
"flatPath": "v1beta1/operations/{operationsId}",
"path": "v1beta1/operations/{+name}",
"id": "speech.operations.get"
- },
- "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": "^[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/operations/{operationsId}:cancel",
- "path": "v1beta1/operations/{+name}:cancel",
- "id": "speech.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",
- "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}",
- "path": "v1beta1/operations/{+name}",
- "id": "speech.operations.delete"
}
}
},
"speech": {
"methods": {
"asyncrecognize": {
+ "request": {
+ "$ref": "AsyncRecognizeRequest"
+ },
+ "description": "Performs asynchronous speech recognition: receive results via the\n[google.longrunning.Operations]\n(/speech/reference/rest/v1beta1/operations#Operation)\ninterface. Returns either an\n`Operation.error` or an `Operation.response` which contains\nan `AsyncRecognizeResponse` message.",
"response": {
"$ref": "Operation"
},
"parameterOrder": [],
"httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {},
"flatPath": "v1beta1/speech:asyncrecognize",
"path": "v1beta1/speech:asyncrecognize",
- "id": "speech.speech.asyncrecognize",
- "description": "Performs asynchronous speech recognition: receive results via the\n[google.longrunning.Operations]\n(/speech/reference/rest/v1beta1/operations#Operation)\ninterface. Returns either an\n`Operation.error` or an `Operation.response` which contains\nan `AsyncRecognizeResponse` message.",
- "request": {
- "$ref": "AsyncRecognizeRequest"
- }
+ "id": "speech.speech.asyncrecognize"
},
"syncrecognize": {
"response": {
@@ -158,9 +158,49 @@
}
},
"parameters": {
- "$.xgafv": {
- "description": "V1 error format.",
+ "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": {
+ "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"
@@ -169,7 +209,9 @@
"enum": [
"1",
"2"
- ]
+ ],
+ "description": "V1 error format.",
+ "type": "string"
},
"callback": {
"description": "JSONP",
@@ -177,6 +219,7 @@
"location": "query"
},
"alt": {
+ "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -189,67 +232,24 @@
"json",
"media",
"proto"
- ],
- "type": "string"
+ ]
},
"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",
- "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": {
- "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"
}
},
"version": "v1beta1",
"baseUrl": "https://speech.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Converts audio to text by applying powerful neural network models.",
"servicePath": "",
+ "description": "Converts audio to text by applying powerful neural network models.",
+ "kind": "discovery#restDescription",
"basePath": "",
"revision": "20171213",
"documentationLink": "https://cloud.google.com/speech/",
@@ -257,6 +257,38 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "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"
+ },
+ "SpeechContext": {
+ "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",
+ "description": "Provides \"hints\" to the speech recognizer to favor specific words and phrases\nin the results.",
+ "type": "object"
+ },
"SpeechRecognitionAlternative": {
"description": "Alternative hypotheses (a.k.a. n-best list).",
"type": "object",
@@ -273,41 +305,7 @@
},
"id": "SpeechRecognitionAlternative"
},
- "SpeechContext": {
- "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",
- "description": "Provides \"hints\" to the speech recognizer to favor specific words and phrases\nin the results.",
- "type": "object"
- },
- "ListOperationsResponse": {
- "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.",
- "type": "object"
- },
"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`).",
@@ -317,60 +315,48 @@
}
}
},
- "id": "SpeechRecognitionResult"
+ "id": "SpeechRecognitionResult",
+ "description": "A speech recognition result corresponding to a portion of the audio.",
+ "type": "object"
+ },
+ "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": {
+ "uri": {
+ "description": "URI that points to a file that contains audio data bytes as specified in\n`RecognitionConfig`. Currently, only Google Cloud Storage URIs are\nsupported, which must be specified in the following format:\n`gs://bucket_name/object_name` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](https://cloud.google.com/storage/docs/reference-uris).",
+ "type": "string"
+ },
+ "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.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "RecognitionAudio"
},
"AsyncRecognizeRequest": {
- "description": "The top-level message sent by the client for the `AsyncRecognize` method.",
- "type": "object",
"properties": {
"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"
+ "$ref": "RecognitionAudio",
+ "description": "*Required* The audio data to be recognized."
}
},
- "id": "AsyncRecognizeRequest"
- },
- "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.",
- "format": "byte",
- "type": "string"
- },
- "uri": {
- "description": "URI that points to a file that contains audio data bytes as specified in\n`RecognitionConfig`. Currently, only Google Cloud Storage URIs are\nsupported, which must be specified in the following format:\n`gs://bucket_name/object_name` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](https://cloud.google.com/storage/docs/reference-uris).",
- "type": "string"
- }
- },
- "id": "RecognitionAudio"
+ "id": "AsyncRecognizeRequest",
+ "description": "The top-level message sent by the client for the `AsyncRecognize` method.",
+ "type": "object"
},
"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."
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
},
"metadata": {
"additionalProperties": {
@@ -379,13 +365,29 @@
},
"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"
+ },
+ "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"
+ "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.",
@@ -406,8 +408,8 @@
"type": "boolean"
},
"speechContext": {
- "description": "*Optional* A means to provide context to assist the speech recognition.",
- "$ref": "SpeechContext"
+ "$ref": "SpeechContext",
+ "description": "*Optional* A means to provide context to assist the speech recognition."
},
"encoding": {
"enumDescriptions": [
@@ -430,17 +432,15 @@
"type": "string"
}
},
- "id": "RecognitionConfig",
- "description": "Provides information to the recognizer that specifies how to process the\nrequest.",
- "type": "object"
+ "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."
+ "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.",
@@ -449,33 +449,6 @@
},
"id": "SyncRecognizeRequest"
},
- "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"
- },
"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",
@@ -490,6 +463,33 @@
},
"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": {
+ "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"
+ },
"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",
@@ -497,11 +497,11 @@
"id": "Empty"
}
},
- "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": "Speech",
"auth": {
"oauth2": {
diff --git a/storagetransfer/v1/storagetransfer-api.json b/storagetransfer/v1/storagetransfer-api.json
index 841fb09..5fc3924 100644
--- a/storagetransfer/v1/storagetransfer-api.json
+++ b/storagetransfer/v1/storagetransfer-api.json
@@ -1,24 +1,13 @@
{
- "version": "v1",
- "baseUrl": "https://storagetransfer.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "servicePath": "",
- "description": "Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.",
"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",
- "revision": "20171207",
+ "revision": "20171214",
"documentationLink": "https://cloud.google.com/storage/transfer",
"id": "storagetransfer:v1",
"title": "Google Storage Transfer API",
@@ -29,34 +18,128 @@
"googleServiceAccounts": {
"methods": {
"get": {
- "id": "storagetransfer.googleServiceAccounts.get",
+ "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.",
- "httpMethod": "GET",
"response": {
"$ref": "GoogleServiceAccount"
},
"parameterOrder": [
"projectId"
],
+ "httpMethod": "GET",
"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"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/googleServiceAccounts/{projectId}"
+ ]
}
}
},
"transferJobs": {
"methods": {
+ "patch": {
+ "flatPath": "v1/transferJobs/{transferJobsId}",
+ "id": "storagetransfer.transferJobs.patch",
+ "path": "v1/{+jobName}",
+ "request": {
+ "$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.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "jobName"
+ ],
+ "response": {
+ "$ref": "TransferJob"
+ },
+ "parameters": {
+ "jobName": {
+ "description": "The name of job to update.\nRequired.",
+ "required": true,
+ "type": "string",
+ "pattern": "^transferJobs/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "get": {
+ "response": {
+ "$ref": "TransferJob"
+ },
+ "parameterOrder": [
+ "jobName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "jobName": {
+ "location": "path",
+ "description": "The job to get.\nRequired.",
+ "required": true,
+ "type": "string",
+ "pattern": "^transferJobs/.+$"
+ },
+ "projectId": {
+ "location": "query",
+ "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/transferJobs/{transferJobsId}",
+ "path": "v1/{+jobName}",
+ "id": "storagetransfer.transferJobs.get",
+ "description": "Gets a transfer job."
+ },
+ "list": {
+ "description": "Lists transfer jobs.",
+ "response": {
+ "$ref": "ListTransferJobsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "description": "The list page size. The max allowed value is 256.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/transferJobs",
+ "path": "v1/transferJobs",
+ "id": "storagetransfer.transferJobs.list"
+ },
"create": {
+ "description": "Creates a transfer job that runs periodically.",
+ "request": {
+ "$ref": "TransferJob"
+ },
"response": {
"$ref": "TransferJob"
},
@@ -68,106 +151,131 @@
"parameters": {},
"flatPath": "v1/transferJobs",
"path": "v1/transferJobs",
- "id": "storagetransfer.transferJobs.create",
- "description": "Creates a transfer job that runs periodically.",
- "request": {
- "$ref": "TransferJob"
- }
- },
- "patch": {
- "response": {
- "$ref": "TransferJob"
- },
- "parameterOrder": [
- "jobName"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "jobName": {
- "description": "The name of job to update.\nRequired.",
- "required": true,
- "type": "string",
- "pattern": "^transferJobs/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/transferJobs/{transferJobsId}",
- "path": "v1/{+jobName}",
- "id": "storagetransfer.transferJobs.patch",
- "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.",
- "request": {
- "$ref": "UpdateTransferJobRequest"
- }
- },
- "get": {
- "description": "Gets a transfer job.",
- "response": {
- "$ref": "TransferJob"
- },
- "parameterOrder": [
- "jobName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "jobName": {
- "pattern": "^transferJobs/.+$",
- "location": "path",
- "description": "The job to get.\nRequired.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/transferJobs/{transferJobsId}",
- "path": "v1/{+jobName}",
- "id": "storagetransfer.transferJobs.get"
- },
- "list": {
- "response": {
- "$ref": "ListTransferJobsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "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": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/transferJobs",
- "path": "v1/transferJobs",
- "id": "storagetransfer.transferJobs.list",
- "description": "Lists transfer jobs."
+ "id": "storagetransfer.transferJobs.create"
}
}
},
"transferOperations": {
"methods": {
+ "list": {
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "description": "The list page size. The max allowed value is 256.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A list of query parameters specified as JSON text in the form of {\\\"project_id\\\" : \\\"my_project_id\\\", \\\"job_names\\\" : [\\\"jobid1\\\", \\\"jobid2\\\",...], \\\"operation_names\\\" : [\\\"opid1\\\", \\\"opid2\\\",...], \\\"transfer_statuses\\\":[\\\"status1\\\", \\\"status2\\\",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `job_names`, `operation_names`, and `transfer_statuses` are optional.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The value `transferOperations`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^transferOperations$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The list page token.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/transferOperations",
+ "path": "v1/{+name}",
+ "id": "storagetransfer.transferOperations.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."
+ },
+ "resume": {
+ "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"
+ ],
+ "flatPath": "v1/transferOperations/{transferOperationsId}:resume",
+ "path": "v1/{+name}:resume",
+ "id": "storagetransfer.transferOperations.resume",
+ "request": {
+ "$ref": "ResumeTransferOperationRequest"
+ },
+ "description": "Resumes a transfer operation that is paused."
+ },
+ "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"
+ },
+ "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": "^transferOperations/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/transferOperations/{transferOperationsId}",
+ "id": "storagetransfer.transferOperations.get",
+ "path": "v1/{+name}"
+ },
"pause": {
"httpMethod": "POST",
"parameterOrder": [
@@ -178,11 +286,11 @@
},
"parameters": {
"name": {
- "pattern": "^transferOperations/.+$",
- "location": "path",
"description": "The name of the transfer operation.\nRequired.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^transferOperations/.+$",
+ "location": "path"
}
},
"scopes": [
@@ -207,11 +315,11 @@
"httpMethod": "DELETE",
"parameters": {
"name": {
+ "location": "path",
"description": "The name of the operation resource to be deleted.",
"required": true,
"type": "string",
- "pattern": "^transferOperations/.+$",
- "location": "path"
+ "pattern": "^transferOperations/.+$"
}
},
"scopes": [
@@ -220,140 +328,21 @@
"flatPath": "v1/transferOperations/{transferOperationsId}",
"path": "v1/{+name}",
"id": "storagetransfer.transferOperations.delete"
- },
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "filter": {
- "description": "A list of query parameters specified as JSON text in the form of {\\\"project_id\\\" : \\\"my_project_id\\\", \\\"job_names\\\" : [\\\"jobid1\\\", \\\"jobid2\\\",...], \\\"operation_names\\\" : [\\\"opid1\\\", \\\"opid2\\\",...], \\\"transfer_statuses\\\":[\\\"status1\\\", \\\"status2\\\",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `job_names`, `operation_names`, and `transfer_statuses` are optional.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The value `transferOperations`.",
- "required": true,
- "type": "string",
- "pattern": "^transferOperations$",
- "location": "path"
- },
- "pageToken": {
- "description": "The list page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "The list page size. The max allowed value is 256.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1/transferOperations",
- "path": "v1/{+name}",
- "id": "storagetransfer.transferOperations.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."
- },
- "resume": {
- "path": "v1/{+name}:resume",
- "id": "storagetransfer.transferOperations.resume",
- "description": "Resumes a transfer operation that is paused.",
- "request": {
- "$ref": "ResumeTransferOperationRequest"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the transfer operation.\nRequired.",
- "required": true,
- "type": "string",
- "pattern": "^transferOperations/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/transferOperations/{transferOperationsId}:resume"
- },
- "cancel": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^transferOperations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string"
- }
- },
- "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."
- },
- "get": {
- "id": "storagetransfer.transferOperations.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",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^transferOperations/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/transferOperations/{transferOperationsId}"
}
}
}
},
"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"
},
"fields": {
"location": "query",
@@ -361,28 +350,28 @@
"type": "string"
},
"uploadType": {
+ "location": "query",
"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"
+ "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": {
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -399,40 +388,383 @@
],
"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"
},
+ "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",
- "location": "query"
+ "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"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
}
},
"schemas": {
+ "TransferOptions": {
+ "description": "TransferOptions uses three boolean parameters to define the actions\nto be performed on objects in a transfer.",
+ "type": "object",
+ "properties": {
+ "overwriteObjectsAlreadyExistingInSink": {
+ "description": "Whether overwriting objects that already exist in the sink is allowed.",
+ "type": "boolean"
+ },
+ "deleteObjectsFromSourceAfterTransfer": {
+ "description": "Whether objects should be deleted from the source after they are\ntransferred to the sink. Note that this option and\n`deleteObjectsUniqueInSink` are mutually exclusive.",
+ "type": "boolean"
+ },
+ "deleteObjectsUniqueInSink": {
+ "description": "Whether objects that exist only in the sink should be deleted. Note that\nthis option and `deleteObjectsFromSourceAfterTransfer` are mutually\nexclusive.",
+ "type": "boolean"
+ }
+ },
+ "id": "TransferOptions"
+ },
+ "TransferSpec": {
+ "description": "Configuration for running a transfer.",
+ "type": "object",
+ "properties": {
+ "gcsDataSource": {
+ "description": "A Google Cloud Storage data source.",
+ "$ref": "GcsData"
+ },
+ "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.",
+ "$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"
+ },
+ "ResumeTransferOperationRequest": {
+ "description": "Request passed to ResumeTransferOperation.",
+ "type": "object",
+ "properties": {},
+ "id": "ResumeTransferOperationRequest"
+ },
+ "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": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ }
+ },
+ "id": "Status"
+ },
+ "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"
+ },
+ "GoogleServiceAccount": {
+ "description": "Google service account",
+ "type": "object",
+ "properties": {
+ "accountEmail": {
+ "description": "Required.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleServiceAccount"
+ },
+ "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"
+ },
+ "ErrorLogEntry": {
+ "description": "An entry describing an error that has occurred.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "A URL that refers to the target (a data source, a data sink,\nor an object) with which the error is associated.\nRequired.",
+ "type": "string"
+ },
+ "errorDetails": {
+ "description": "A list of messages that carry the error details.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ErrorLogEntry"
+ },
+ "TransferJob": {
+ "description": "This resource represents the configuration of a transfer job that runs\nperiodically.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "A description provided by the user for the job. Its max length is 1024\nbytes when Unicode-encoded.",
+ "type": "string"
+ },
+ "creationTime": {
+ "description": "This field cannot be changed by user requests.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "transferSpec": {
+ "description": "Transfer specification.",
+ "$ref": "TransferSpec"
+ },
+ "status": {
+ "enumDescriptions": [
+ "Zero is an illegal value.",
+ "New transfers will be performed based on the schedule.",
+ "New transfers will not be scheduled.",
+ "This is a soft delete state. After a transfer job is set to this\nstate, the job and all the transfer executions are subject to\ngarbage collection."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "ENABLED",
+ "DISABLED",
+ "DELETED"
+ ],
+ "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.",
+ "type": "string"
+ },
+ "schedule": {
+ "$ref": "Schedule",
+ "description": "Schedule specification."
+ },
+ "name": {
+ "description": "A globally unique name assigned by Storage Transfer Service when the\njob is created. This field should be left empty in requests to create a new\ntransfer job; otherwise, the requests result in an `INVALID_ARGUMENT`\nerror.",
+ "type": "string"
+ },
+ "deletionTime": {
+ "description": "This field cannot be changed by user requests.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The ID of the Google Cloud Platform Console project that owns the job.",
+ "type": "string"
+ },
+ "lastModificationTime": {
+ "description": "This field cannot be changed by user requests.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "TransferJob"
+ },
+ "Schedule": {
+ "description": "Transfers can be scheduled to recur or to run just once.",
+ "type": "object",
+ "properties": {
+ "scheduleEndDate": {
+ "$ref": "Date",
+ "description": "The last day the recurring transfer will be run. If `scheduleEndDate`\nis the same as `scheduleStartDate`, the transfer will be executed only\nonce."
+ },
+ "startTimeOfDay": {
+ "$ref": "TimeOfDay",
+ "description": "The time in UTC at which the transfer will be scheduled to start in a day.\nTransfers may start later than this time. If not specified, recurring and\none-time transfers that are scheduled to run today will run immediately;\nrecurring transfers that are scheduled to run on a future date will start\nat approximately midnight UTC on that date. Note that when configuring a\ntransfer with the Cloud Platform Console, the transfer's start time in a\nday is specified in your local timezone."
+ },
+ "scheduleStartDate": {
+ "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": {
+ "projectId": {
+ "description": "The ID of the Google Cloud Platform Console project that owns the operation.\nRequired.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "End time of this transfer execution.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Start time of this transfer execution.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "transferJobName": {
+ "description": "The name of the transfer job that triggers this transfer operation.",
+ "type": "string"
+ },
+ "transferSpec": {
+ "$ref": "TransferSpec",
+ "description": "Transfer specification.\nRequired."
+ },
+ "counters": {
+ "description": "Information about the progress of the transfer operation.",
+ "$ref": "TransferCounters"
+ },
+ "status": {
+ "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"
+ ],
+ "description": "Status of the transfer operation.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "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.",
@@ -443,34 +775,18 @@
"type": "string"
}
},
- "id": "AwsAccessKey",
- "description": "AWS access key (see\n[AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).",
- "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": "AwsAccessKey"
},
"PauseTransferOperationRequest": {
- "properties": {},
- "id": "PauseTransferOperationRequest",
"description": "Request passed to PauseTransferOperation.",
- "type": "object"
+ "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",
@@ -540,29 +856,27 @@
"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"
}
},
- "id": "TransferCounters",
- "description": "A collection of counters that report the progress of a transfer operation.",
- "type": "object"
+ "id": "TransferCounters"
},
"ErrorSummary": {
"description": "A summary of errors by error code, plus a count and sample error log\nentries.",
"type": "object",
"properties": {
- "errorCount": {
- "description": "Count of this type of error.\nRequired.",
- "format": "int64",
- "type": "string"
- },
- "errorLogEntries": {
- "description": "Error samples.",
- "type": "array",
- "items": {
- "$ref": "ErrorLogEntry"
- }
- },
"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",
@@ -600,9 +914,19 @@
"INTERNAL",
"UNAVAILABLE",
"DATA_LOSS"
- ],
- "description": "Required.",
+ ]
+ },
+ "errorCount": {
+ "description": "Count of this type of error.\nRequired.",
+ "format": "int64",
"type": "string"
+ },
+ "errorLogEntries": {
+ "description": "Error samples.",
+ "type": "array",
+ "items": {
+ "$ref": "ErrorLogEntry"
+ }
}
},
"id": "ErrorSummary"
@@ -619,35 +943,37 @@
"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",
"properties": {
"bucketName": {
"description": "Google Cloud Storage bucket name (see\n[Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).\nRequired.",
"type": "string"
}
},
- "id": "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"
+ "id": "GcsData"
},
"ListTransferJobsResponse": {
"description": "Response from ListTransferJobs.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The list next page token.",
- "type": "string"
- },
"transferJobs": {
"description": "A list of transfer jobs.",
"type": "array",
"items": {
"$ref": "TransferJob"
}
+ },
+ "nextPageToken": {
+ "description": "The list next page token.",
+ "type": "string"
}
},
"id": "ListTransferJobsResponse"
},
"UpdateTransferJobRequest": {
+ "description": "Request passed to UpdateTransferJob.",
+ "type": "object",
"properties": {
"transferJob": {
"$ref": "TransferJob",
@@ -663,9 +989,7 @@
"type": "string"
}
},
- "id": "UpdateTransferJobRequest",
- "description": "Request passed to UpdateTransferJob.",
- "type": "object"
+ "id": "UpdateTransferJobRequest"
},
"ObjectConditions": {
"description": "Conditions that determine which objects will be transferred.",
@@ -707,20 +1031,20 @@
"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`.",
"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": {
@@ -732,346 +1056,22 @@
}
},
"id": "Operation"
- },
- "TransferOptions": {
- "properties": {
- "overwriteObjectsAlreadyExistingInSink": {
- "description": "Whether overwriting objects that already exist in the sink is allowed.",
- "type": "boolean"
- },
- "deleteObjectsFromSourceAfterTransfer": {
- "description": "Whether objects should be deleted from the source after they are\ntransferred to the sink. Note that this option and\n`deleteObjectsUniqueInSink` are mutually exclusive.",
- "type": "boolean"
- },
- "deleteObjectsUniqueInSink": {
- "description": "Whether objects that exist only in the sink should be deleted. Note that\nthis option and `deleteObjectsFromSourceAfterTransfer` are mutually\nexclusive.",
- "type": "boolean"
- }
- },
- "id": "TransferOptions",
- "description": "TransferOptions uses three boolean parameters to define the actions\nto be performed on objects in a transfer.",
- "type": "object"
- },
- "TransferSpec": {
- "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": {
- "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": {
- "description": "A Google Cloud Storage data sink.",
- "$ref": "GcsData"
- },
- "gcsDataSource": {
- "$ref": "GcsData",
- "description": "A Google Cloud Storage data source."
- },
- "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.",
- "$ref": "TransferOptions"
- }
- },
- "id": "TransferSpec"
- },
- "ResumeTransferOperationRequest": {
- "description": "Request passed to ResumeTransferOperation.",
- "type": "object",
- "properties": {},
- "id": "ResumeTransferOperationRequest"
- },
- "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"
- },
- "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"
- },
- "GoogleServiceAccount": {
- "description": "Google service account",
- "type": "object",
- "properties": {
- "accountEmail": {
- "description": "Required.",
- "type": "string"
- }
- },
- "id": "GoogleServiceAccount"
- },
- "TimeOfDay": {
- "properties": {
- "minutes": {
- "description": "Minutes of hour of day. Must be from 0 to 59.",
- "format": "int32",
- "type": "integer"
- },
- "hours": {
- "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
- "format": "int32",
- "type": "integer"
- },
- "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"
- }
- },
- "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"
- },
- "ErrorLogEntry": {
- "description": "An entry describing an error that has occurred.",
- "type": "object",
- "properties": {
- "url": {
- "description": "A URL that refers to the target (a data source, a data sink,\nor an object) with which the error is associated.\nRequired.",
- "type": "string"
- },
- "errorDetails": {
- "description": "A list of messages that carry the error details.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ErrorLogEntry"
- },
- "TransferJob": {
- "description": "This resource represents the configuration of a transfer job that runs\nperiodically.",
- "type": "object",
- "properties": {
- "description": {
- "description": "A description provided by the user for the job. Its max length is 1024\nbytes when Unicode-encoded.",
- "type": "string"
- },
- "transferSpec": {
- "description": "Transfer specification.",
- "$ref": "TransferSpec"
- },
- "creationTime": {
- "description": "This field cannot be changed by user requests.",
- "format": "google-datetime",
- "type": "string"
- },
- "status": {
- "enumDescriptions": [
- "Zero is an illegal value.",
- "New transfers will be performed based on the schedule.",
- "New transfers will not be scheduled.",
- "This is a soft delete state. After a transfer job is set to this\nstate, the job and all the transfer executions are subject to\ngarbage collection."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "ENABLED",
- "DISABLED",
- "DELETED"
- ],
- "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.",
- "type": "string"
- },
- "schedule": {
- "$ref": "Schedule",
- "description": "Schedule specification."
- },
- "deletionTime": {
- "description": "This field cannot be changed by user requests.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "A globally unique name assigned by Storage Transfer Service when the\njob is created. This field should be left empty in requests to create a new\ntransfer job; otherwise, the requests result in an `INVALID_ARGUMENT`\nerror.",
- "type": "string"
- },
- "lastModificationTime": {
- "description": "This field cannot be changed by user requests.",
- "format": "google-datetime",
- "type": "string"
- },
- "projectId": {
- "description": "The ID of the Google Cloud Platform Console project that owns the job.",
- "type": "string"
- }
- },
- "id": "TransferJob"
- },
- "Schedule": {
- "properties": {
- "scheduleEndDate": {
- "description": "The last day the recurring transfer will be run. If `scheduleEndDate`\nis the same as `scheduleStartDate`, the transfer will be executed only\nonce.",
- "$ref": "Date"
- },
- "startTimeOfDay": {
- "$ref": "TimeOfDay",
- "description": "The time in UTC at which the transfer will be scheduled to start in a day.\nTransfers may start later than this time. If not specified, recurring and\none-time transfers that are scheduled to run today will run immediately;\nrecurring transfers that are scheduled to run on a future date will start\nat approximately midnight UTC on that date. Note that when configuring a\ntransfer with the Cloud Platform Console, the transfer's start time in a\nday is specified in your local timezone."
- },
- "scheduleStartDate": {
- "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",
- "description": "Transfers can be scheduled to recur or to run just once.",
- "type": "object"
- },
- "Date": {
- "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
- "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": {
- "enum": [
- "STATUS_UNSPECIFIED",
- "IN_PROGRESS",
- "PAUSED",
- "SUCCESS",
- "FAILED",
- "ABORTED"
- ],
- "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."
- ]
- },
- "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": {
- "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",
- "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"
}
},
+ "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"
+ "version": "v1",
+ "baseUrl": "https://storagetransfer.googleapis.com/",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ }
}
diff --git a/streetviewpublish/v1/streetviewpublish-api.json b/streetviewpublish/v1/streetviewpublish-api.json
index c23490c..86f42d6 100644
--- a/streetviewpublish/v1/streetviewpublish-api.json
+++ b/streetviewpublish/v1/streetviewpublish-api.json
@@ -1,35 +1,480 @@
{
- "id": "streetviewpublish:v1",
+ "canonicalName": "Street View Publish",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/streetviewpublish": {
+ "description": "Publish and manage your 360 photos on Google Street View"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://streetviewpublish.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "streetviewpublish",
+ "batchPath": "batch",
+ "fullyEncodeReservedExpansion": true,
+ "title": "Street View Publish API",
+ "ownerName": "Google",
+ "resources": {
+ "photos": {
+ "methods": {
+ "batchUpdate": {
+ "response": {
+ "$ref": "BatchUpdatePhotosResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "flatPath": "v1/photos:batchUpdate",
+ "path": "v1/photos:batchUpdate",
+ "id": "streetviewpublish.photos.batchUpdate",
+ "request": {
+ "$ref": "BatchUpdatePhotosRequest"
+ },
+ "description": "Updates the metadata of Photos, such\nas pose, place association, connections, etc. Changing the pixels of photos\nis not supported.\n\nNote that if\nBatchUpdatePhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchUpdatePhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchUpdatePhotosResponse.results.\nSee\nUpdatePhoto\nfor specific failures that can occur per photo.\n\nOnly the fields specified in\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"
+ },
+ "batchDelete": {
+ "response": {
+ "$ref": "BatchDeletePhotosResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "flatPath": "v1/photos:batchDelete",
+ "path": "v1/photos:batchDelete",
+ "id": "streetviewpublish.photos.batchDelete",
+ "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."
+ },
+ "batchGet": {
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "BatchGetPhotosResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "parameters": {
+ "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"
+ },
+ "photoIds": {
+ "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&...`.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/photos:batchGet",
+ "id": "streetviewpublish.photos.batchGet",
+ "path": "v1/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": {
+ "response": {
+ "$ref": "ListPhotosResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "filter": {
+ "description": "The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.\n\nThe only filter supported at the moment is `placeId`.",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
+ },
+ "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",
+ "path": "v1/photos",
+ "id": "streetviewpublish.photos.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"
+ }
+ }
+ },
+ "photo": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "photoId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "photoId": {
+ "location": "path",
+ "description": "Required. ID of the Photo.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "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."
+ },
+ "get": {
+ "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",
+ "parameters": {
+ "photoId": {
+ "location": "path",
+ "description": "Required. ID of the Photo.",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "enum": [
+ "BASIC",
+ "INCLUDE_DOWNLOAD_URL"
+ ],
+ "description": "Specifies if a download URL for the photo bytes should be returned in the\nPhoto response.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "flatPath": "v1/photo/{photoId}"
+ },
+ "update": {
+ "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"
+ },
+ "response": {
+ "$ref": "Photo"
+ },
+ "parameterOrder": [
+ "id"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "parameters": {
+ "id": {
+ "description": "Required. A unique identifier for a photo.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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}"
+ },
+ "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"
+ }
+ },
+ "startUpload": {
+ "path": "v1/photo:startUpload",
+ "id": "streetviewpublish.photo.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",
+ "scopes": [
+ "https://www.googleapis.com/auth/streetviewpublish"
+ ],
+ "parameters": {},
+ "flatPath": "v1/photo:startUpload"
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "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"
+ },
+ "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": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "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"
+ },
+ "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://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",
+ "basePath": "",
"documentationLink": "https://developers.google.com/streetview/publish/",
+ "id": "streetviewpublish:v1",
"revision": "20171214",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "PhotoResponse": {
- "description": "Response payload for a single\nPhoto\nin batch operations including\nBatchGetPhotos\nand\nBatchUpdatePhotos.",
+ "Photo": {
+ "description": "Photo is used to store 360 photos along with photo metadata.",
"type": "object",
"properties": {
- "status": {
- "description": "The status for the operation to get or update a single photo in the batch\nrequest.",
- "$ref": "Status"
+ "downloadUrl": {
+ "description": "Output only. The download URL for the photo bytes. This field is set only\nwhen\nGetPhotoRequest.view\nis set to\nPhotoView.INCLUDE_DOWNLOAD_URL.",
+ "type": "string"
},
+ "places": {
+ "description": "Places where this photo belongs.",
+ "type": "array",
+ "items": {
+ "$ref": "Place"
+ }
+ },
+ "connections": {
+ "description": "Connections to other photos. A connection represents the link from this\nphoto to another photo.",
+ "type": "array",
+ "items": {
+ "$ref": "Connection"
+ }
+ },
+ "uploadReference": {
+ "description": "Required when creating a photo. Input only. The resource URL where the\nphoto bytes are uploaded to.",
+ "$ref": "UploadRef"
+ },
+ "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.",
+ "$ref": "PhotoId"
+ },
+ "pose": {
+ "$ref": "Pose",
+ "description": "Pose of the photo."
+ },
+ "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"
+ },
+ "viewCount": {
+ "description": "Output only. View count of the photo.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "Photo"
+ },
+ "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": "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",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
+ },
+ "PhotoResponse": {
+ "properties": {
"photo": {
"$ref": "Photo",
"description": "The Photo resource, if the request\nwas successful."
+ },
+ "status": {
+ "$ref": "Status",
+ "description": "The status for the operation to get or update a single photo in the batch\nrequest."
}
},
- "id": "PhotoResponse"
+ "id": "PhotoResponse",
+ "description": "Response payload for a single\nPhoto\nin batch operations including\nBatchGetPhotos\nand\nBatchUpdatePhotos.",
+ "type": "object"
},
"Connection": {
- "description": "A connection is the link from a source photo to a destination photo.",
- "type": "object",
"properties": {
"target": {
- "description": "Required. The destination of the connection from the containing photo to\nanother photo.",
- "$ref": "PhotoId"
+ "$ref": "PhotoId",
+ "description": "Required. The destination of the connection from the containing photo to\nanother photo."
}
},
- "id": "Connection"
+ "id": "Connection",
+ "description": "A connection is the link from a source photo to a destination photo.",
+ "type": "object"
},
"BatchUpdatePhotosResponse": {
"description": "Response to batch update of metadata of one or more\nPhotos.",
@@ -45,20 +490,6 @@
},
"id": "BatchUpdatePhotosResponse"
},
- "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": {
"properties": {
"message": {
@@ -86,28 +517,42 @@
"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"
},
+ "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"
+ },
+ "Level": {
+ "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"
+ }
+ },
+ "id": "Level",
+ "description": "Level information containing level number and its corresponding name.",
+ "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"
},
- "Level": {
- "description": "Level information containing level number and its corresponding name.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- }
- },
- "id": "Level"
- },
"BatchGetPhotosResponse": {
"properties": {
"results": {
@@ -123,15 +568,15 @@
"type": "object"
},
"Place": {
- "description": "Place metadata for an entity.",
- "type": "object",
"properties": {
"placeId": {
"description": "Place identifier, as described in\nhttps://developers.google.com/places/place-id.",
"type": "string"
}
},
- "id": "Place"
+ "id": "Place",
+ "description": "Place metadata for an entity.",
+ "type": "object"
},
"UploadRef": {
"properties": {
@@ -177,14 +622,14 @@
},
"UpdatePhotoRequest": {
"properties": {
- "photo": {
- "description": "Required. Photo object containing the\nnew metadata.",
- "$ref": "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"
+ },
+ "photo": {
+ "$ref": "Photo",
+ "description": "Required. Photo object containing the\nnew metadata."
}
},
"id": "UpdatePhotoRequest",
@@ -203,18 +648,7 @@
"id": "PhotoId"
},
"Pose": {
- "description": "Raw pose measurement for an entity.",
- "type": "object",
"properties": {
- "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."
- },
- "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"
@@ -233,9 +667,20 @@
"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.",
"format": "double",
"type": "number"
+ },
+ "latLngPair": {
+ "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"
}
},
- "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.",
@@ -252,472 +697,27 @@
"id": "BatchUpdatePhotosRequest"
},
"ListPhotosResponse": {
- "description": "Response to list all photos that belong to a user.",
- "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"
+ },
"photos": {
"description": "List of photos. The maximum number of items returned is based on the\npageSize field\nin the request.",
"type": "array",
"items": {
"$ref": "Photo"
}
- },
- "nextPageToken": {
- "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.",
- "type": "string"
}
},
- "id": "ListPhotosResponse"
- },
- "Photo": {
- "description": "Photo is used to store 360 photos along with photo metadata.",
- "type": "object",
- "properties": {
- "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"
- },
- "viewCount": {
- "description": "Output only. View count of the photo.",
- "format": "int64",
- "type": "string"
- },
- "downloadUrl": {
- "description": "Output only. The download URL for the photo bytes. This field is set only\nwhen\nGetPhotoRequest.view\nis set to\nPhotoView.INCLUDE_DOWNLOAD_URL.",
- "type": "string"
- },
- "places": {
- "description": "Places where this photo belongs.",
- "type": "array",
- "items": {
- "$ref": "Place"
- }
- },
- "connections": {
- "description": "Connections to other photos. A connection represents the link from this\nphoto to another photo.",
- "type": "array",
- "items": {
- "$ref": "Connection"
- }
- },
- "uploadReference": {
- "$ref": "UploadRef",
- "description": "Required when creating a photo. Input only. The resource URL where the\nphoto bytes are uploaded to."
- },
- "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.",
- "$ref": "PhotoId"
- },
- "pose": {
- "description": "Pose of the photo.",
- "$ref": "Pose"
- }
- },
- "id": "Photo"
- },
- "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": "ListPhotosResponse",
+ "description": "Response to list all photos that belong to a user.",
+ "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",
- "canonicalName": "Street View Publish",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/streetviewpublish": {
- "description": "Publish and manage your 360 photos on Google Street View"
- }
- }
- }
- },
- "rootUrl": "https://streetviewpublish.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "streetviewpublish",
- "batchPath": "batch",
- "fullyEncodeReservedExpansion": true,
- "title": "Street View Publish API",
- "ownerName": "Google",
- "resources": {
- "photo": {
- "methods": {
- "get": {
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {
- "photoId": {
- "location": "path",
- "description": "Required. ID of the Photo.",
- "required": true,
- "type": "string"
- },
- "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"
- }
- }
- },
- "update": {
- "response": {
- "$ref": "Photo"
- },
- "parameterOrder": [
- "id"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "id": {
- "location": "path",
- "description": "Required. A unique identifier for a photo.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "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",
- "type": "string"
- }
- },
- "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",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "flatPath": "v1/photo",
- "path": "v1/photo",
- "id": "streetviewpublish.photo.create",
- "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": {
- "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.",
- "response": {
- "$ref": "UploadRef"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "flatPath": "v1/photo:startUpload",
- "path": "v1/photo:startUpload",
- "id": "streetviewpublish.photo.startUpload"
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "photoId"
- ],
- "parameters": {
- "photoId": {
- "location": "path",
- "description": "Required. ID of the Photo.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "flatPath": "v1/photo/{photoId}",
- "id": "streetviewpublish.photo.delete",
- "path": "v1/photo/{photoId}",
- "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."
- }
- }
- },
- "photos": {
- "methods": {
- "batchGet": {
- "httpMethod": "GET",
- "response": {
- "$ref": "BatchGetPhotosResponse"
- },
- "parameterOrder": [],
- "parameters": {
- "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": "string",
- "repeated": true,
- "location": "query"
- },
- "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"
- ]
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "flatPath": "v1/photos:batchGet",
- "id": "streetviewpublish.photos.batchGet",
- "path": "v1/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": {
- "path": "v1/photos",
- "id": "streetviewpublish.photos.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",
- "response": {
- "$ref": "ListPhotosResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {
- "filter": {
- "description": "The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.\n\nThe only filter supported at the moment is `placeId`.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "The\nnextPageToken\nvalue returned from a previous\nListPhotos\nrequest, if any.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "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",
- "location": "query"
- },
- "view": {
- "description": "Specifies if a download URL for the photos bytes should be returned in the\nPhotos response.",
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "INCLUDE_DOWNLOAD_URL"
- ]
- }
- },
- "flatPath": "v1/photos"
- },
- "batchUpdate": {
- "description": "Updates the metadata of Photos, such\nas pose, place association, connections, etc. Changing the pixels of photos\nis not supported.\n\nNote that if\nBatchUpdatePhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchUpdatePhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchUpdatePhotosResponse.results.\nSee\nUpdatePhoto\nfor specific failures that can occur per photo.\n\nOnly the fields specified in\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",
- "request": {
- "$ref": "BatchUpdatePhotosRequest"
- },
- "response": {
- "$ref": "BatchUpdatePhotosResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {},
- "flatPath": "v1/photos:batchUpdate",
- "path": "v1/photos:batchUpdate",
- "id": "streetviewpublish.photos.batchUpdate"
- },
- "batchDelete": {
- "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.",
- "request": {
- "$ref": "BatchDeletePhotosRequest"
- },
- "response": {
- "$ref": "BatchDeletePhotosResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/streetviewpublish"
- ],
- "parameters": {},
- "flatPath": "v1/photos:batchDelete",
- "path": "v1/photos:batchDelete",
- "id": "streetviewpublish.photos.batchDelete"
- }
- }
- }
- },
- "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"
- },
- "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": {
- "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": {
- "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"
- }
- },
- "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",
- "basePath": ""
+ }
}
diff --git a/testing/v1/testing-api.json b/testing/v1/testing-api.json
index ef175af..1ec98c2 100644
--- a/testing/v1/testing-api.json
+++ b/testing/v1/testing-api.json
@@ -1,192 +1,36 @@
{
- "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"
- }
- }
- }
- },
- "servicePath": "",
- "description": "Allows developers to run automated tests for their mobile applications on Google infrastructure.",
- "kind": "discovery#restDescription",
- "rootUrl": "https://testing.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "testing",
- "batchPath": "batch",
- "revision": "20171213",
- "documentationLink": "https://developers.google.com/cloud-test-lab/",
- "id": "testing:v1",
- "title": "Google Cloud Testing API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
- "resources": {
- "testEnvironmentCatalog": {
- "methods": {
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "TestEnvironmentCatalog"
- },
- "parameterOrder": [
- "environmentType"
- ],
- "parameters": {
- "projectId": {
- "location": "query",
- "description": "For authorization, the cloud project requesting the TestEnvironmentCatalog.\nOptional",
- "type": "string"
- },
- "environmentType": {
- "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}",
- "id": "testing.testEnvironmentCatalog.get",
- "path": "v1/testEnvironmentCatalog/{environmentType}",
- "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"
- }
- }
- },
- "projects": {
- "resources": {
- "testMatrices": {
- "methods": {
- "cancel": {
- "response": {
- "$ref": "CancelTestMatrixResponse"
- },
- "parameterOrder": [
- "projectId",
- "testMatrixId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "testMatrixId": {
- "description": "Test matrix that will be canceled.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "Cloud project that owns the test.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel",
- "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}: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"
- },
- "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",
- "response": {
- "$ref": "TestMatrix"
- },
- "parameterOrder": [
- "projectId",
- "testMatrixId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "testMatrixId": {
- "location": "path",
- "description": "Unique test matrix id which was assigned by the service.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Cloud project that owns the test matrix.",
- "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}",
- "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}",
- "id": "testing.projects.testMatrices.get"
- },
- "create": {
- "response": {
- "$ref": "TestMatrix"
- },
- "parameterOrder": [
- "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": {
- "description": "The GCE project under which this job will run.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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"
- }
- }
- }
- }
- }
- }
- },
"parameters": {
+ "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"
+ "default": "true",
+ "location": "query"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"fields": {
"location": "query",
@@ -194,17 +38,17 @@
"type": "string"
},
"$.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": {
"description": "JSONP",
@@ -228,9 +72,9 @@
"default": "json"
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"key": {
"location": "query",
@@ -241,26 +85,98 @@
"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"
}
},
"schemas": {
+ "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",
+ "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"
+ }
+ },
+ "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": {
+ "description": "The APK for the application under test.\nRequired",
+ "$ref": "FileReference"
+ },
+ "appPackageId": {
+ "description": "The java package for the application under test.\nOptional, default is determined by examining the application's manifest.",
+ "type": "string"
+ }
+ },
+ "id": "AndroidTestLoop"
+ },
+ "NetworkConfigurationCatalog": {
+ "type": "object",
+ "properties": {
+ "configurations": {
+ "type": "array",
+ "items": {
+ "$ref": "NetworkConfiguration"
+ }
+ }
+ },
+ "id": "NetworkConfigurationCatalog"
+ },
+ "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": {
+ "properties": {
+ "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"
+ },
+ "models": {
+ "description": "The set of supported Android device models.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "AndroidModel"
+ }
+ }
+ },
+ "id": "AndroidDeviceCatalog",
+ "description": "The currently supported Android devices.",
+ "type": "object"
+ },
+ "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": {
+ "id": "ClientInfo",
"description": "Information about the client which invoked the test.",
"type": "object",
"properties": {
@@ -272,50 +188,52 @@
}
},
"name": {
- "description": "Client name, such as gcloud.\nRequired",
- "type": "string"
+ "type": "string",
+ "description": "Client name, such as gcloud.\nRequired"
}
- },
- "id": "ClientInfo"
+ }
},
"EnvironmentMatrix": {
- "description": "The matrix of environments in which the test is to be executed.",
- "type": "object",
"properties": {
"androidDeviceList": {
"$ref": "AndroidDeviceList",
"description": "A list of Android devices; the test will be run only on the specified\ndevices."
},
"androidMatrix": {
- "description": "A matrix of Android devices.",
- "$ref": "AndroidMatrix"
+ "$ref": "AndroidMatrix",
+ "description": "A matrix of Android devices."
}
},
- "id": "EnvironmentMatrix"
+ "id": "EnvironmentMatrix",
+ "description": "The matrix of environments in which the test is to be executed.",
+ "type": "object"
},
"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.",
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
"format": "int32",
"type": "integer"
},
+ "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": {
+ "id": "CancelTestMatrixResponse",
+ "description": "Response containing the current state of the specified test matrix.",
+ "type": "object",
"properties": {
"testState": {
"enum": [
@@ -347,12 +265,11 @@
"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",
- "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"
@@ -361,11 +278,12 @@
"$ref": "LauncherActivityIntent"
}
},
- "id": "RoboStartingIntent",
- "description": "Message for specifying the start activities to crawl",
- "type": "object"
+ "id": "RoboStartingIntent"
},
"StartActivityIntent": {
+ "id": "StartActivityIntent",
+ "description": "A starting intent specified by an action, uri, and categories.",
+ "type": "object",
"properties": {
"action": {
"description": "Action name.\nRequired for START_ACTIVITY.",
@@ -376,16 +294,13 @@
"type": "string"
},
"categories": {
- "description": "Intent categories to set on the intent.\nOptional.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "Intent categories to set on the intent.\nOptional."
}
- },
- "id": "StartActivityIntent",
- "description": "A starting intent specified by an action, uri, and categories.",
- "type": "object"
+ }
},
"Account": {
"description": "Identifies an account and how to log into it",
@@ -399,57 +314,57 @@
"id": "Account"
},
"TestEnvironmentCatalog": {
+ "description": "A description of a test environment.",
+ "type": "object",
"properties": {
"androidDeviceCatalog": {
- "description": "Android devices suitable for running Android Instrumentation Tests.",
- "$ref": "AndroidDeviceCatalog"
+ "$ref": "AndroidDeviceCatalog",
+ "description": "Android devices suitable for running Android Instrumentation Tests."
},
"networkConfigurationCatalog": {
- "description": "Supported network configurations",
- "$ref": "NetworkConfigurationCatalog"
+ "$ref": "NetworkConfigurationCatalog",
+ "description": "Supported network configurations"
}
},
- "id": "TestEnvironmentCatalog",
- "description": "A description of a test environment.",
- "type": "object"
+ "id": "TestEnvironmentCatalog"
},
"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"
- }
+ },
+ "description": "Tags for this dimension.\nExamples: \"default\""
},
"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"
+ "type": "string",
+ "description": "A human-friendly string representing the region for this locale.\nExample: \"United States\"\nNot present for every locale.\n@OutputOnly"
}
},
- "id": "Locale",
- "description": "A location/region designation for language.",
- "type": "object"
+ "id": "Locale"
},
"ObbFile": {
"description": "An opaque binary blob file to install on the device before the test starts",
"type": "object",
"properties": {
+ "obb": {
+ "description": "Opaque Binary Blob (OBB) file(s) to install on the device\nRequired",
+ "$ref": "FileReference"
+ },
"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": {
- "$ref": "FileReference",
- "description": "Opaque Binary Blob (OBB) file(s) to install on the device\nRequired"
}
},
"id": "ObbFile"
@@ -466,17 +381,21 @@
}
},
"locales": {
- "description": "The set of available locales.\n@OutputOnly",
"type": "array",
"items": {
"$ref": "Locale"
- }
+ },
+ "description": "The set of available locales.\n@OutputOnly"
}
},
"id": "AndroidRuntimeConfiguration"
},
"AndroidDevice": {
"properties": {
+ "locale": {
+ "description": "The locale the test device used for testing.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
+ "type": "string"
+ },
"androidModelId": {
"description": "The id of the Android device to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired",
"type": "string"
@@ -488,10 +407,6 @@
"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",
@@ -520,10 +435,6 @@
"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"
@@ -535,14 +446,24 @@
"historyId": {
"description": "A tool results history ID.\n@OutputOnly",
"type": "string"
+ },
+ "executionId": {
+ "description": "A tool results execution ID.\n@OutputOnly",
+ "type": "string"
}
},
"id": "ToolResultsStep"
},
"TrafficRule": {
+ "id": "TrafficRule",
"description": "Network emulation parameters",
"type": "object",
"properties": {
+ "packetDuplicationRatio": {
+ "description": "Packet duplication ratio (0.0 - 1.0)",
+ "format": "float",
+ "type": "number"
+ },
"delay": {
"description": "Packet delay, must be \u003e= 0",
"format": "google-duration",
@@ -562,40 +483,13 @@
"description": "Bandwidth in kbits/second",
"format": "float",
"type": "number"
- },
- "packetDuplicationRatio": {
- "description": "Packet duplication ratio (0.0 - 1.0)",
- "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": {
- "orchestratorOption": {
- "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",
- "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."
- ]
- },
- "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"
- }
- },
"testApk": {
"$ref": "FileReference",
"description": "The APK containing the test code to be executed.\nRequired"
@@ -615,6 +509,27 @@
"appApk": {
"description": "The APK for the application under test.\nRequired",
"$ref": "FileReference"
+ },
+ "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": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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."
}
},
"id": "AndroidInstrumentationTest"
@@ -631,6 +546,8 @@
"type": "object"
},
"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": {
"key": {
"description": "The key of detailed client information.\nRequired",
@@ -641,35 +558,33 @@
"type": "string"
}
},
- "id": "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"
+ "id": "ClientInfoDetail"
},
"EnvironmentVariable": {
"description": "A key-value pair passed as an environment variable to the test",
"type": "object",
"properties": {
- "value": {
- "description": "Value for the environment variable",
- "type": "string"
- },
"key": {
"description": "Key for the environment variable",
"type": "string"
+ },
+ "value": {
+ "description": "Value for the environment variable",
+ "type": "string"
}
},
"id": "EnvironmentVariable"
},
"Environment": {
+ "id": "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",
- "description": "The environment in which the test is run.",
- "type": "object"
+ }
},
"GoogleCloudStorage": {
"description": "A storage location within Google cloud storage (GCS).",
@@ -683,21 +598,13 @@
"id": "GoogleCloudStorage"
},
"TestExecution": {
+ "id": "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"
- },
- "timestamp": {
- "description": "The time this test execution was initially created.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
"testDetails": {
- "$ref": "TestDetails",
- "description": "Additional details about the running test.\n@OutputOnly"
+ "description": "Additional details about the running test.\n@OutputOnly",
+ "$ref": "TestDetails"
},
"matrixId": {
"description": "Id of the containing TestMatrix.\n@OutputOnly",
@@ -738,8 +645,8 @@
"type": "string"
},
"toolResultsStep": {
- "description": "Where the results for this execution are written.\n@OutputOnly",
- "$ref": "ToolResultsStep"
+ "$ref": "ToolResultsStep",
+ "description": "Where the results for this execution are written.\n@OutputOnly"
},
"testSpecification": {
"description": "How to run the test.\n@OutputOnly",
@@ -748,24 +655,34 @@
"projectId": {
"description": "The cloud project that owns the test execution.\n@OutputOnly",
"type": "string"
+ },
+ "id": {
+ "description": "Unique id set by the backend.\n@OutputOnly",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "The time this test execution was initially created.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
}
- },
- "id": "TestExecution"
+ }
},
"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": {
- "enum": [
- "ACTION_TYPE_UNSPECIFIED",
- "SINGLE_CLICK",
- "ENTER_TEXT"
- ],
"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.",
"Direct Robo to enter text on the specified element. No-op if specified\nelement is not enabled or does not allow text entry."
+ ],
+ "enum": [
+ "ACTION_TYPE_UNSPECIFIED",
+ "SINGLE_CLICK",
+ "ENTER_TEXT"
]
},
"resourceName": {
@@ -777,12 +694,17 @@
"type": "string"
}
},
- "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"
+ "id": "RoboDirective"
},
"AndroidMatrix": {
"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",
@@ -803,13 +725,6 @@
"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"
- }
}
},
"id": "AndroidMatrix",
@@ -820,29 +735,6 @@
"description": "A description of an Android device tests may be run on.",
"type": "object",
"properties": {
- "name": {
- "description": "The human-readable marketing name for this device model.\nExamples: \"Nexus 5\", \"Galaxy S5\"\n@OutputOnly",
- "type": "string"
- },
- "id": {
- "description": "The unique opaque id for this model.\nUse this for invoking the TestExecutionService.\n@OutputOnly",
- "type": "string"
- },
- "tags": {
- "description": "Tags for this dimension.\nExamples: \"default\", \"preview\", \"deprecated\"",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "manufacturer": {
- "description": "The manufacturer of this device.\n@OutputOnly",
- "type": "string"
- },
- "brand": {
- "description": "The company that this device is branded with.\nExample: \"Google\", \"Samsung\"\n@OutputOnly",
- "type": "string"
- },
"screenX": {
"description": "Screen size in the horizontal (X) dimension measured in pixels.\n@OutputOnly",
"format": "int32",
@@ -872,16 +764,16 @@
"type": "string"
},
"screenDensity": {
+ "type": "integer",
"description": "Screen density in DPI.\nThis corresponds to ro.sf.lcd_density\n@OutputOnly",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"supportedVersionIds": {
- "description": "The set of Android versions this device supports.\n@OutputOnly",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "The set of Android versions this device supports.\n@OutputOnly"
},
"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",
@@ -889,14 +781,49 @@
"items": {
"type": "string"
}
+ },
+ "name": {
+ "description": "The human-readable marketing name for this device model.\nExamples: \"Nexus 5\", \"Galaxy S5\"\n@OutputOnly",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique opaque id for this model.\nUse this for invoking the TestExecutionService.\n@OutputOnly",
+ "type": "string"
+ },
+ "tags": {
+ "description": "Tags for this dimension.\nExamples: \"default\", \"preview\", \"deprecated\"",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "manufacturer": {
+ "description": "The manufacturer of this device.\n@OutputOnly",
+ "type": "string"
+ },
+ "brand": {
+ "description": "The company that this device is branded with.\nExample: \"Google\", \"Samsung\"\n@OutputOnly",
+ "type": "string"
}
},
"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",
+ "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"
+ }
+ },
"networkProfile": {
"description": "The network traffic profile used for running the test.\nOptional",
"type": "string"
@@ -911,28 +838,21 @@
"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"
+ "id": "TestSetup",
+ "description": "A description of how to set up the device prior to running the test",
+ "type": "object"
},
"TestSpecification": {
"description": "A description of how to run the test.",
"type": "object",
"properties": {
+ "testTimeout": {
+ "description": "Max time a test execution is allowed to run before it is\nautomatically cancelled.\nOptional, default is 5 min.",
+ "format": "google-duration",
+ "type": "string"
+ },
"autoGoogleLogin": {
"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"
@@ -946,12 +866,12 @@
"$ref": "TestSetup"
},
"androidRoboTest": {
- "$ref": "AndroidRoboTest",
- "description": "An Android robo test."
+ "description": "An Android robo test.",
+ "$ref": "AndroidRoboTest"
},
"androidInstrumentationTest": {
- "description": "An Android instrumentation test.",
- "$ref": "AndroidInstrumentationTest"
+ "$ref": "AndroidInstrumentationTest",
+ "description": "An Android instrumentation test."
},
"disablePerformanceMetrics": {
"description": "Disables performance metrics recording; may reduce test latency.",
@@ -960,20 +880,75 @@
"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",
- "type": "string"
}
},
"id": "TestSpecification"
},
"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": {
+ "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": "Indicates the current progress of the test matrix (e.g., FINISHED)\n@OutputOnly"
+ },
+ "testSpecification": {
+ "description": "How to run the test.\nRequired",
+ "$ref": "TestSpecification"
+ },
+ "projectId": {
+ "description": "The cloud project that owns the test matrix.\n@OutputOnly",
+ "type": "string"
+ },
+ "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",
+ "type": "array",
+ "items": {
+ "$ref": "TestExecution"
+ }
+ },
+ "timestamp": {
+ "description": "The time this test matrix was initially created.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "environmentMatrix": {
+ "description": "How the host machine(s) are configured.\nRequired",
+ "$ref": "EnvironmentMatrix"
+ },
"resultStorage": {
- "description": "Where the results for the matrix are written.\nRequired",
- "$ref": "ResultStorage"
+ "$ref": "ResultStorage",
+ "description": "Where the results for the matrix are written.\nRequired"
},
"testMatrixId": {
"description": "Unique id set by the service.\n@OutputOnly",
@@ -1026,71 +1001,12 @@
],
"description": "Describes why the matrix is considered invalid.\nOnly useful for matrices in the INVALID state.\n@OutputOnly",
"type": "string"
- },
- "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",
- "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"
- },
- "testSpecification": {
- "$ref": "TestSpecification",
- "description": "How to run the test.\nRequired"
- },
- "projectId": {
- "description": "The cloud project that owns the test matrix.\n@OutputOnly",
- "type": "string"
- },
- "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",
- "type": "array",
- "items": {
- "$ref": "TestExecution"
- }
- },
- "timestamp": {
- "description": "The time this test matrix was initially created.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "environmentMatrix": {
- "description": "How the host machine(s) are configured.\nRequired",
- "$ref": "EnvironmentMatrix"
}
},
- "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"
+ "id": "TestMatrix"
},
"ResultStorage": {
+ "type": "object",
"properties": {
"toolResultsHistory": {
"$ref": "ToolResultsHistory",
@@ -1101,16 +1017,25 @@
"description": "Required."
},
"toolResultsExecution": {
- "description": "The tool results execution that results are written to.\n@OutputOnly",
- "$ref": "ToolResultsExecution"
+ "$ref": "ToolResultsExecution",
+ "description": "The tool results execution that results are written to.\n@OutputOnly"
}
},
"id": "ResultStorage",
- "description": "Locations where the results of running the test are stored.",
- "type": "object"
+ "description": "Locations where the results of running the test are stored."
},
"AndroidVersion": {
+ "description": "A version of the Android OS",
+ "type": "object",
"properties": {
+ "versionString": {
+ "description": "A string representing this version of the Android OS.\nExamples: \"4.3\", \"4.4\"\n@OutputOnly",
+ "type": "string"
+ },
+ "codeName": {
+ "description": "The code name for this Android version.\nExamples: \"JellyBean\", \"KitKat\"\n@OutputOnly",
+ "type": "string"
+ },
"apiLevel": {
"description": "The API level for this Android version.\nExamples: 18, 19\n@OutputOnly",
"format": "int32",
@@ -1121,8 +1046,8 @@
"$ref": "Distribution"
},
"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"
},
"id": {
"description": "An opaque id for this Android version.\nUse this id to invoke the TestExecutionService.\n@OutputOnly",
@@ -1134,19 +1059,9 @@
"items": {
"type": "string"
}
- },
- "versionString": {
- "description": "A string representing this version of the Android OS.\nExamples: \"4.3\", \"4.4\"\n@OutputOnly",
- "type": "string"
- },
- "codeName": {
- "description": "The code name for this Android version.\nExamples: \"JellyBean\", \"KitKat\"\n@OutputOnly",
- "type": "string"
}
},
- "id": "AndroidVersion",
- "description": "A version of the Android OS",
- "type": "object"
+ "id": "AndroidVersion"
},
"FileReference": {
"description": "A reference to a file, used for user inputs.",
@@ -1160,10 +1075,10 @@
"id": "FileReference"
},
"LauncherActivityIntent": {
- "properties": {},
- "id": "LauncherActivityIntent",
"description": "Specifies an intent that starts the main launcher activity.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "LauncherActivityIntent"
},
"TestDetails": {
"description": "Additional details about the progress of the running test.",
@@ -1203,7 +1118,6 @@
"id": "ToolResultsExecution"
},
"ToolResultsHistory": {
- "description": "Represents a tool results history resource.",
"type": "object",
"properties": {
"projectId": {
@@ -1215,10 +1129,30 @@
"type": "string"
}
},
- "id": "ToolResultsHistory"
+ "id": "ToolResultsHistory",
+ "description": "Represents a tool results history resource."
},
"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.",
+ "type": "object",
"properties": {
+ "maxSteps": {
+ "type": "integer",
+ "description": "The max number of steps Robo can execute.\nDefault is no limit.\nOptional",
+ "format": "int32"
+ },
+ "appInitialActivity": {
+ "description": "The initial activity that should be used to start the app.\nOptional",
+ "type": "string"
+ },
+ "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",
@@ -1233,32 +1167,13 @@
"type": "string"
},
"startingIntents": {
- "description": "The intents used to launch the app for the crawl.\nIf none are provided, then the main launcher activity is launched.\nIf some are provided, then only those provided are launched (the main\nlauncher activity must be provided explicitly).",
"type": "array",
"items": {
"$ref": "RoboStartingIntent"
- }
- },
- "maxSteps": {
- "description": "The max number of steps Robo can execute.\nDefault is no limit.\nOptional",
- "format": "int32",
- "type": "integer"
- },
- "appInitialActivity": {
- "description": "The initial activity that should be used to start the app.\nOptional",
- "type": "string"
- },
- "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"
- }
+ },
+ "description": "The intents used to launch the app for the crawl.\nIf none are provided, then the main launcher activity is launched.\nIf some are provided, then only those provided are launched (the main\nlauncher activity must be provided explicitly)."
}
- },
- "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.",
- "type": "object"
+ }
},
"Distribution": {
"description": "Data about the relative number of devices running a\ngiven configuration of the Android platform.",
@@ -1270,9 +1185,9 @@
"type": "number"
},
"measurementTime": {
+ "type": "string",
"description": "The time this distribution was measured.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
}
},
"id": "Distribution"
@@ -1281,6 +1196,10 @@
"description": "Screen orientation of the device.",
"type": "object",
"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"
@@ -1291,105 +1210,186 @@
"items": {
"type": "string"
}
- },
- "name": {
- "description": "A human-friendly name for this orientation.\nExample: \"portrait\"\n@OutputOnly",
- "type": "string"
}
},
"id": "Orientation"
- },
- "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"
- }
- },
- "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": {
- "description": "The APK for the application under test.\nRequired",
- "$ref": "FileReference"
- },
- "appPackageId": {
- "description": "The java package for the application under test.\nOptional, default is determined by examining the application's manifest.",
- "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"
- },
- "NetworkConfigurationCatalog": {
- "type": "object",
- "properties": {
- "configurations": {
- "type": "array",
- "items": {
- "$ref": "NetworkConfiguration"
- }
- }
- },
- "id": "NetworkConfigurationCatalog"
- },
- "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": {
- "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",
- "description": "The currently supported Android devices.",
- "type": "object"
- },
- "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"
}
},
"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://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"
+ }
+ }
+ }
+ },
+ "servicePath": "",
+ "description": "Allows developers to run automated tests for their mobile applications on Google infrastructure.",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://testing.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "testing",
+ "batchPath": "batch",
+ "revision": "20171213",
+ "documentationLink": "https://developers.google.com/cloud-test-lab/",
+ "id": "testing:v1",
+ "title": "Google Cloud Testing API",
+ "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",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "TestEnvironmentCatalog"
+ },
+ "parameterOrder": [
+ "environmentType"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "query",
+ "description": "For authorization, the cloud project requesting the TestEnvironmentCatalog.\nOptional",
+ "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"
+ ]
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/testEnvironmentCatalog/{environmentType}",
+ "id": "testing.testEnvironmentCatalog.get",
+ "path": "v1/testEnvironmentCatalog/{environmentType}"
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "testMatrices": {
+ "methods": {
+ "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",
+ "response": {
+ "$ref": "TestMatrix"
+ },
+ "parameterOrder": [
+ "projectId",
+ "testMatrixId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Cloud project that owns the test matrix.",
+ "required": true,
+ "type": "string"
+ },
+ "testMatrixId": {
+ "location": "path",
+ "description": "Unique test matrix id which was assigned by the service.",
+ "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}/testMatrices/{testMatrixId}",
+ "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}",
+ "id": "testing.projects.testMatrices.get"
+ },
+ "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"
+ },
+ "response": {
+ "$ref": "TestMatrix"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The GCE project under which this job will run.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/testMatrices",
+ "path": "v1/projects/{projectId}/testMatrices",
+ "id": "testing.projects.testMatrices.create"
+ },
+ "cancel": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Cloud project that owns the test.",
+ "required": true,
+ "type": "string"
+ },
+ "testMatrixId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Test matrix that will be canceled."
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel",
+ "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}: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",
+ "response": {
+ "$ref": "CancelTestMatrixResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "testMatrixId"
+ ],
+ "httpMethod": "POST"
+ }
+ }
+ }
+ }
+ }
+ }
}
diff --git a/tpu/v1alpha1/tpu-api.json b/tpu/v1alpha1/tpu-api.json
index 946efad..2e46e50 100644
--- a/tpu/v1alpha1/tpu-api.json
+++ b/tpu/v1alpha1/tpu-api.json
@@ -6,54 +6,10 @@
"locations": {
"methods": {
"list": {
- "flatPath": "v1alpha1/projects/{projectsId}/locations",
- "id": "tpu.projects.locations.list",
- "path": "v1alpha1/{+name}/locations",
"description": "Lists information about the supported locations for this service.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "ListLocationsResponse"
},
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The resource that owns the locations collection, if applicable."
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The standard list page token."
- },
- "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"
- ]
- },
- "get": {
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}",
- "path": "v1alpha1/{+name}",
- "id": "tpu.projects.locations.get",
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
"parameterOrder": [
"name"
],
@@ -62,225 +18,191 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
"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",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1alpha1/projects/{projectsId}/locations",
+ "path": "v1alpha1/{+name}/locations",
+ "id": "tpu.projects.locations.list"
+ },
+ "get": {
+ "id": "tpu.projects.locations.get",
+ "path": "v1alpha1/{+name}",
+ "description": "Get information about a location.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Location"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path",
- "description": "Resource name for the location."
+ "description": "Resource name for the location.",
+ "required": true,
+ "type": "string"
}
- }
+ },
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}"
}
},
"resources": {
- "operations": {
+ "nodes": {
"methods": {
- "cancel": {
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: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",
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled."
- }
- },
+ "delete": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "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`.",
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
+ "location": "path",
+ "description": "The resource name.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}",
+ "id": "tpu.projects.locations.nodes.delete",
+ "path": "v1alpha1/{+name}",
+ "description": "Deletes a node.",
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
- "id": "tpu.projects.locations.operations.delete",
- "path": "v1alpha1/{+name}"
+ "$ref": "Operation"
+ }
},
- "list": {
- "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations",
- "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": {
- "name": {
- "location": "path",
- "description": "The name of the operation's parent resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "get": {
+ "reset": {
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$"
- }
- },
+ "httpMethod": "POST",
"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."
- }
- }
- },
- "nodes": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListNodesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
"parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The next_page_token value returned from a previous List request, if any."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "The maximum number of items to return.",
- "format": "int32"
- },
- "parent": {
+ "name": {
+ "description": "The resource name.",
"required": true,
"type": "string",
+ "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",
+ "description": "Resets a node, which stops and starts the VM.",
+ "request": {
+ "$ref": "ResetNodeRequest"
+ }
+ },
+ "list": {
+ "parameters": {
+ "parent": {
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path",
- "description": "The parent resource name."
+ "description": "The parent resource name.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The next_page_token value returned from a previous List request, if any.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of items to return.",
+ "format": "int32",
+ "type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes",
- "path": "v1alpha1/{+parent}/nodes",
"id": "tpu.projects.locations.nodes.list",
- "description": "Lists nodes."
+ "path": "v1alpha1/{+parent}/nodes",
+ "description": "Lists nodes.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListNodesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ]
},
"reimage": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
"parameters": {
"name": {
- "location": "path",
"description": "The resource name.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$"
+ "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:reimage",
- "id": "tpu.projects.locations.nodes.reimage",
"path": "v1alpha1/{+name}:reimage",
+ "id": "tpu.projects.locations.nodes.reimage",
"request": {
"$ref": "ReimageNodeRequest"
},
- "description": "Reimage a node's OS."
- },
- "create": {
- "description": "Creates a node.",
- "request": {
- "$ref": "Node"
- },
+ "description": "Reimage a node's OS.",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
- "parent"
+ "name"
],
- "httpMethod": "POST",
+ "httpMethod": "POST"
+ },
+ "create": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path",
"description": "The parent resource name.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$"
+ "type": "string"
},
"nodeId": {
"location": "query",
@@ -289,8 +211,19 @@
}
},
"flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes",
+ "id": "tpu.projects.locations.nodes.create",
"path": "v1alpha1/{+parent}/nodes",
- "id": "tpu.projects.locations.nodes.create"
+ "description": "Creates a node.",
+ "request": {
+ "$ref": "Node"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Operation"
+ }
},
"get": {
"response": {
@@ -302,11 +235,11 @@
"httpMethod": "GET",
"parameters": {
"name": {
+ "description": "The resource name.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
- "location": "path",
- "description": "The resource name."
+ "location": "path"
}
},
"scopes": [
@@ -316,59 +249,126 @@
"path": "v1alpha1/{+name}",
"id": "tpu.projects.locations.nodes.get",
"description": "Gets the details of a node."
+ }
+ }
+ },
+ "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",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/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": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
+ "id": "tpu.projects.locations.operations.cancel",
+ "path": "v1alpha1/{+name}:cancel"
},
"delete": {
- "description": "Deletes a node.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
"httpMethod": "DELETE",
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
- "location": "path",
- "description": "The resource name."
- }
+ "response": {
+ "$ref": "Empty"
},
- "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",
- "id": "tpu.projects.locations.nodes.reset",
- "path": "v1alpha1/{+name}:reset",
- "request": {
- "$ref": "ResetNodeRequest"
- },
- "description": "Resets a node, which stops and starts the VM.",
- "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "response": {
- "$ref": "Operation"
- },
"parameters": {
"name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$",
+ "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"location": "path",
- "description": "The resource name."
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+ "id": "tpu.projects.locations.operations.delete",
+ "path": "v1alpha1/{+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`."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "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 standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations",
+ "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."
+ },
+ "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": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+ "path": "v1alpha1/{+name}",
+ "id": "tpu.projects.locations.operations.get"
}
}
}
@@ -378,98 +378,98 @@
}
},
"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"
+ "default": "true",
+ "location": "query"
},
"uploadType": {
- "type": "string",
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ "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",
- "description": "Selector specifying which fields to include in a partial response."
+ "location": "query"
},
"$.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": {
- "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",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
- "description": "Data format for response."
- },
- "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": "Data format for response.",
+ "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.",
+ "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",
- "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",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"oauth_token": {
- "type": "string",
"location": "query",
- "description": "OAuth 2.0 token for the current user."
+ "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": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
}
},
"version": "v1alpha1",
"baseUrl": "https://tpu.googleapis.com/",
"servicePath": "",
- "description": "TPU API provides customers with access to Google TPU technology.",
"kind": "discovery#restDescription",
+ "description": "TPU API provides customers with access to Google TPU technology.",
"basePath": "",
"id": "tpu:v1alpha1",
"documentationLink": "https://cloud.google.com/tpu/",
@@ -477,86 +477,8 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "ListOperationsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "The standard List next-page token."
- },
- "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."
- },
- "OperationMetadata": {
- "description": "Represents the metadata of the long-running operation.",
- "type": "object",
- "properties": {
- "endTime": {
- "type": "string",
- "description": "[Output only] The time the operation finished running.",
- "format": "google-datetime"
- },
- "cancelRequested": {
- "type": "boolean",
- "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`."
- },
- "verb": {
- "type": "string",
- "description": "[Output only] Name of the verb executed by the operation."
- },
- "createTime": {
- "description": "[Output only] The time the operation was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "statusDetail": {
- "type": "string",
- "description": "[Output only] Human-readable status of the operation, if any."
- },
- "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"
- }
- },
- "id": "OperationMetadata"
- },
- "ListLocationsResponse": {
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "The standard List next-page token."
- },
- "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."
- },
- "ResetNodeRequest": {
- "description": "Request for ResetNode.",
- "type": "object",
- "properties": {},
- "id": "ResetNodeRequest"
- },
"Node": {
+ "description": "A TPU instance.",
"type": "object",
"properties": {
"tensorflowVersion": {
@@ -575,6 +497,7 @@
}
},
"state": {
+ "description": "The current state for the TPU Node.\nOutput only.",
"type": "string",
"enumDescriptions": [
"TPU node state is not known/set.",
@@ -593,17 +516,16 @@
"REIMAGING",
"DELETING",
"REPAIRING"
- ],
- "description": "The current state for the TPU Node.\nOutput only."
+ ]
+ },
+ "acceleratorType": {
+ "description": "The type of hardware accelerators associated with this node.\nRequired.",
+ "type": "string"
},
"name": {
"description": "The immutable name of the TPU",
"type": "string"
},
- "acceleratorType": {
- "type": "string",
- "description": "The type of hardware accelerators associated with this node.\nRequired."
- },
"port": {
"description": "Output only.\nDEPRECATED! Use network_endpoints instead.\nThe network port for the TPU Node as visible to GCE instances.",
"type": "string"
@@ -613,57 +535,65 @@
"type": "string"
},
"network": {
- "type": "string",
- "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."
+ "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": "If this field is populated, it contains a description of why the TPU Node\nis unhealthy.\nOutput only.",
"type": "string"
},
"ipAddress": {
- "type": "string",
- "description": "Output only.\nDEPRECATED! Use network_endpoints instead.\nThe network address for the TPU Node as visible to GCE instances."
- },
- "createTime": {
- "type": "string",
- "description": "The time when the node was created.\nOutput only.",
- "format": "google-datetime"
+ "description": "Output only.\nDEPRECATED! Use network_endpoints instead.\nThe network address for the TPU Node as visible to GCE instances.",
+ "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"
+ },
+ "createTime": {
+ "description": "The time when the node was created.\nOutput only.",
+ "format": "google-datetime",
+ "type": "string"
}
},
- "id": "Node",
- "description": "A TPU instance."
+ "id": "Node"
},
"NetworkEndpoint": {
+ "id": "NetworkEndpoint",
+ "description": "A network endpoint over which a TPU worker can be reached.",
"type": "object",
"properties": {
"ipAddress": {
- "type": "string",
- "description": "The IP address of this network endpoint."
+ "description": "The IP address of this network endpoint.",
+ "type": "string"
},
"port": {
- "type": "integer",
"description": "The port of this network endpoint.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
}
- },
- "id": "NetworkEndpoint",
- "description": "A network endpoint over which a TPU worker can be reached."
+ }
},
"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"
- },
- "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.",
@@ -671,67 +601,58 @@
},
"response": {
"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"
- },
- "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."
}
- },
- "id": "Operation"
+ }
},
"ListNodesResponse": {
+ "description": "Response for ListNodes.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The next page token or empty if none.",
- "type": "string"
- },
"nodes": {
+ "description": "The listed nodes.",
"type": "array",
"items": {
"$ref": "Node"
- },
- "description": "The listed nodes."
- }
- },
- "id": "ListNodesResponse",
- "description": "Response for ListNodes."
- },
- "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": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "type": "object"
}
},
+ "nextPageToken": {
+ "description": "The next page token or empty if none.",
+ "type": "string"
+ }
+ },
+ "id": "ListNodesResponse"
+ },
+ "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"
+ "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": {
+ "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."
+ }
},
"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 `{}`.",
@@ -740,6 +661,7 @@
"id": "Empty"
},
"ReimageNodeRequest": {
+ "description": "Request for ReimageNode.",
"type": "object",
"properties": {
"tensorflowVersion": {
@@ -747,43 +669,121 @@
"type": "string"
}
},
- "id": "ReimageNodeRequest",
- "description": "Request for ReimageNode."
+ "id": "ReimageNodeRequest"
},
"Location": {
+ "id": "Location",
"description": "A resource that represents Google Cloud Platform location.",
"type": "object",
"properties": {
- "metadata": {
- "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\nlocation."
- },
"labels": {
- "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}"
+ "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": {
- "type": "string",
- "description": "The canonical id for this location. For example: `\"us-east1\"`."
+ "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": {
+ "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": "Location"
+ "id": "ListOperationsResponse"
+ },
+ "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"
+ }
+ },
+ "id": "OperationMetadata"
+ },
+ "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"
+ },
+ "ResetNodeRequest": {
+ "id": "ResetNodeRequest",
+ "description": "Request for ResetNode.",
+ "type": "object",
+ "properties": {}
}
},
"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": "TPU",
diff --git a/translate/v2/translate-api.json b/translate/v2/translate-api.json
index cb8356d..bb743c0 100644
--- a/translate/v2/translate-api.json
+++ b/translate/v2/translate-api.json
@@ -1,11 +1,17 @@
{
+ "rootUrl": "https://translation.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "translate",
+ "batchPath": "batch/translate",
+ "title": "Google Cloud Translation API",
+ "features": [
+ "dataWrapper"
+ ],
"ownerName": "Google",
"resources": {
"detections": {
"methods": {
"list": {
- "path": "v2/detect",
- "id": "language.detections.list",
"description": "Detects the language of text within a request.",
"response": {
"$ref": "DetectionsListResponse"
@@ -14,10 +20,6 @@
"q"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-translation",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"q": {
"repeated": true,
@@ -26,9 +28,20 @@
"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"
},
"detect": {
+ "response": {
+ "$ref": "DetectionsListResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-translation",
@@ -39,28 +52,27 @@
"description": "Detects the language of text within a request.",
"request": {
"$ref": "DetectLanguageRequest"
- },
- "response": {
- "$ref": "DetectionsListResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST"
+ }
}
}
},
"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": {
"location": "query",
"description": "The model type for which supported languages should be returned.",
"type": "string"
+ },
+ "target": {
+ "description": "The language to use to return localized, human readable names of supported\nlanguages.",
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
@@ -69,19 +81,31 @@
],
"path": "v2/languages",
"id": "language.languages.list",
- "description": "Returns a list of supported languages for translation.",
- "response": {
- "$ref": "LanguagesListResponse"
- },
- "httpMethod": "GET"
+ "description": "Returns a list of supported languages for translation."
}
}
},
"translations": {
"methods": {
+ "translate": {
+ "request": {
+ "$ref": "TranslateTextRequest"
+ },
+ "description": "Translates input text, returning translated text.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "TranslationsListResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "id": "language.translations.translate",
+ "path": "v2"
+ },
"list": {
- "path": "v2",
- "id": "language.translations.list",
"description": "Translates input text, returning translated text.",
"response": {
"$ref": "TranslationsListResponse"
@@ -91,7 +115,41 @@
"target"
],
"httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-translation",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
+ "cid": {
+ "repeated": true,
+ "location": "query",
+ "description": "The customization id for translate",
+ "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",
+ "required": true,
+ "location": "query"
+ },
+ "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"
+ },
"q": {
"repeated": true,
"location": "query",
@@ -103,65 +161,46 @@
"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": {
- "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,
- "location": "query"
- },
- "format": {
- "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",
- "enumDescriptions": [
- "Specifies the input is in HTML",
- "Specifies the input is in plain textual format"
- ],
- "location": "query",
- "enum": [
- "html",
- "text"
- ]
- },
- "model": {
- "location": "query",
- "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.",
- "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-translation",
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "translate": {
- "response": {
- "$ref": "TranslationsListResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-translation",
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
"path": "v2",
- "id": "language.translations.translate",
- "request": {
- "$ref": "TranslateTextRequest"
- },
- "description": "Translates input text, returning translated text."
+ "id": "language.translations.list"
}
}
}
},
"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. Overrides userIp if both are provided.",
+ "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\").",
@@ -179,9 +218,14 @@
"location": "query"
},
"fields": {
+ "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"$.xgafv": {
"enumDescriptions": [
@@ -196,12 +240,13 @@
"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": [
@@ -209,60 +254,62 @@
"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. Overrides userIp if both are provided.",
- "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": "v2",
"baseUrl": "https://translation.googleapis.com/language/translate/",
- "kind": "discovery#restDescription",
- "description": "The Google Cloud Translation API lets websites and programs integrate with\n Google Translate programmatically.",
"servicePath": "language/translate/",
+ "description": "The Google Cloud Translation API lets websites and programs integrate with\n Google Translate programmatically.",
+ "kind": "discovery#restDescription",
"basePath": "/language/translate/",
- "id": "translate:v2",
- "documentationLink": "https://code.google.com/apis/language/translate/v2/getting_started.html",
"revision": "20170525",
+ "documentationLink": "https://code.google.com/apis/language/translate/v2/getting_started.html",
+ "id": "translate:v2",
"discoveryVersion": "v1",
"schemas": {
+ "TranslationsResource": {
+ "properties": {
+ "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": "TranslationsResource",
+ "type": "object"
+ },
+ "DetectionsResource": {
+ "id": "DetectionsResource",
+ "description": "An array of languages which we detect for the given text The most likely language list first.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "confidence": {
+ "description": "The confidence of the detection result of this language.",
+ "format": "float",
+ "type": "number"
+ },
+ "isReliable": {
+ "description": "A boolean to indicate is the language detection result reliable.",
+ "type": "boolean"
+ },
+ "language": {
+ "description": "The language we detected.",
+ "type": "string"
+ }
+ }
+ }
+ },
"TranslationsListResponse": {
- "description": "The main language translation response message.",
- "type": "object",
"properties": {
"translations": {
"description": "Translations contains list of translation results of given text",
@@ -272,7 +319,9 @@
}
}
},
- "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.",
@@ -305,7 +354,6 @@
"id": "TranslateTextRequest"
},
"DetectLanguageRequest": {
- "id": "DetectLanguageRequest",
"description": "The request message for language detection.",
"type": "object",
"properties": {
@@ -316,11 +364,10 @@
"type": "string"
}
}
- }
+ },
+ "id": "DetectLanguageRequest"
},
"LanguagesResource": {
- "id": "LanguagesResource",
- "type": "object",
"properties": {
"language": {
"description": "Supported language code, generally consisting of its ISO 639-1\nidentifier. (E.g. 'en', 'ja'). In certain cases, BCP-47 codes including\nlanguage + region identifiers are returned (e.g. 'zh-TW' and 'zh-CH')",
@@ -330,10 +377,11 @@
"description": "Human readable name of the language localized to the target language.",
"type": "string"
}
- }
+ },
+ "id": "LanguagesResource",
+ "type": "object"
},
"DetectionsListResponse": {
- "type": "object",
"properties": {
"detections": {
"description": "A detections contains detection results of several text",
@@ -343,7 +391,8 @@
}
}
},
- "id": "DetectionsListResponse"
+ "id": "DetectionsListResponse",
+ "type": "object"
},
"GetSupportedLanguagesRequest": {
"description": "The request message for discovering supported languages.",
@@ -368,54 +417,13 @@
}
},
"id": "LanguagesListResponse"
- },
- "DetectionsResource": {
- "id": "DetectionsResource",
- "description": "An array of languages which we detect for the given text The most likely language list first.",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "confidence": {
- "description": "The confidence of the detection result of this language.",
- "format": "float",
- "type": "number"
- },
- "isReliable": {
- "description": "A boolean to indicate is the language detection result reliable.",
- "type": "boolean"
- },
- "language": {
- "description": "The language we detected.",
- "type": "string"
- }
- }
- }
- },
- "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"
}
},
- "protocol": "rest",
"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": {
@@ -428,13 +436,5 @@
}
}
}
- },
- "rootUrl": "https://translation.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "translate",
- "batchPath": "batch/translate",
- "title": "Google Cloud Translation API",
- "features": [
- "dataWrapper"
- ]
+ }
}
diff --git a/vault/v1/vault-api.json b/vault/v1/vault-api.json
index 65fb419..f4bc7a4 100644
--- a/vault/v1/vault-api.json
+++ b/vault/v1/vault-api.json
@@ -1,9 +1,36 @@
{
- "ownerName": "Google",
"resources": {
"matters": {
"methods": {
+ "delete": {
+ "flatPath": "v1/matters/{matterId}",
+ "path": "v1/matters/{matterId}",
+ "id": "vault.matters.delete",
+ "description": "Deletes the specified matter. Returns matter with updated state.",
+ "response": {
+ "$ref": "Matter"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
+ "parameters": {
+ "matterId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The matter ID"
+ }
+ }
+ },
"addPermissions": {
+ "description": "Adds an account as a matter collaborator.",
+ "request": {
+ "$ref": "AddMatterPermissionsRequest"
+ },
"response": {
"$ref": "MatterPermission"
},
@@ -24,15 +51,18 @@
},
"flatPath": "v1/matters/{matterId}:addPermissions",
"path": "v1/matters/{matterId}:addPermissions",
- "id": "vault.matters.addPermissions",
- "description": "Adds an account as a matter collaborator.",
- "request": {
- "$ref": "AddMatterPermissionsRequest"
- }
+ "id": "vault.matters.addPermissions"
},
"list": {
+ "description": "Lists matters the user has access to.",
+ "response": {
+ "$ref": "ListMattersResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
"state": {
+ "type": "string",
"location": "query",
"enum": [
"STATE_UNSPECIFIED",
@@ -40,8 +70,7 @@
"CLOSED",
"DELETED"
],
- "description": "If set, list only matters with that specific state. The default is listing\nmatters of all states.",
- "type": "string"
+ "description": "If set, list only matters with that specific state. The default is listing\nmatters of all states."
},
"pageToken": {
"location": "query",
@@ -55,14 +84,14 @@
"type": "integer"
},
"view": {
+ "type": "string",
"location": "query",
"enum": [
"VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
- "description": "Specifies which parts of the matter to return in response.",
- "type": "string"
+ "description": "Specifies which parts of the matter to return in response."
}
},
"scopes": [
@@ -71,13 +100,7 @@
],
"flatPath": "v1/matters",
"path": "v1/matters",
- "id": "vault.matters.list",
- "description": "Lists matters the user has access to.",
- "response": {
- "$ref": "ListMattersResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET"
+ "id": "vault.matters.list"
},
"create": {
"response": {
@@ -98,10 +121,6 @@
}
},
"reopen": {
- "request": {
- "$ref": "ReopenMatterRequest"
- },
- "description": "Reopens the specified matter. Returns matter with updated state.",
"response": {
"$ref": "ReopenMatterResponse"
},
@@ -111,10 +130,10 @@
"httpMethod": "POST",
"parameters": {
"matterId": {
+ "location": "path",
"description": "The matter ID.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -122,9 +141,15 @@
],
"flatPath": "v1/matters/{matterId}:reopen",
"path": "v1/matters/{matterId}:reopen",
- "id": "vault.matters.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",
"description": "Removes an account as a matter collaborator.",
"request": {
"$ref": "RemoveMatterPermissionsRequest"
@@ -141,19 +166,15 @@
],
"parameters": {
"matterId": {
+ "location": "path",
"description": "The matter ID.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v1/matters/{matterId}:removePermissions",
- "path": "v1/matters/{matterId}:removePermissions",
- "id": "vault.matters.removePermissions"
+ "flatPath": "v1/matters/{matterId}:removePermissions"
},
"close": {
- "path": "v1/matters/{matterId}:close",
- "id": "vault.matters.close",
"description": "Closes the specified matter. Returns matter with updated state.",
"request": {
"$ref": "CloseMatterRequest"
@@ -176,9 +197,15 @@
"location": "path"
}
},
- "flatPath": "v1/matters/{matterId}:close"
+ "flatPath": "v1/matters/{matterId}:close",
+ "path": "v1/matters/{matterId}:close",
+ "id": "vault.matters.close"
},
"undelete": {
+ "request": {
+ "$ref": "UndeleteMatterRequest"
+ },
+ "description": "Undeletes the specified matter. Returns matter with updated state.",
"response": {
"$ref": "Matter"
},
@@ -199,14 +226,9 @@
],
"flatPath": "v1/matters/{matterId}:undelete",
"path": "v1/matters/{matterId}:undelete",
- "id": "vault.matters.undelete",
- "request": {
- "$ref": "UndeleteMatterRequest"
- },
- "description": "Undeletes the specified matter. Returns matter with updated state."
+ "id": "vault.matters.undelete"
},
"get": {
- "description": "Gets the specified matter.",
"httpMethod": "GET",
"parameterOrder": [
"matterId"
@@ -215,12 +237,6 @@
"$ref": "Matter"
},
"parameters": {
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "required": true,
- "type": "string"
- },
"view": {
"description": "Specifies which parts of the Matter to return in the response.",
"type": "string",
@@ -230,6 +246,12 @@
"BASIC",
"FULL"
]
+ },
+ "matterId": {
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -238,9 +260,14 @@
],
"flatPath": "v1/matters/{matterId}",
"id": "vault.matters.get",
- "path": "v1/matters/{matterId}"
+ "path": "v1/matters/{matterId}",
+ "description": "Gets the specified matter."
},
"update": {
+ "request": {
+ "$ref": "Matter"
+ },
+ "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.",
"response": {
"$ref": "Matter"
},
@@ -250,185 +277,138 @@
"httpMethod": "PUT",
"parameters": {
"matterId": {
- "description": "The matter ID.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "flatPath": "v1/matters/{matterId}",
- "path": "v1/matters/{matterId}",
- "id": "vault.matters.update",
- "request": {
- "$ref": "Matter"
- },
- "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."
- },
- "delete": {
- "response": {
- "$ref": "Matter"
- },
- "parameterOrder": [
- "matterId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "parameters": {
- "matterId": {
"location": "path",
- "description": "The matter ID",
+ "description": "The matter ID.",
"required": true,
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ],
"flatPath": "v1/matters/{matterId}",
"path": "v1/matters/{matterId}",
- "id": "vault.matters.delete",
- "description": "Deletes the specified matter. Returns matter with updated state."
+ "id": "vault.matters.update"
}
},
"resources": {
"holds": {
- "methods": {
- "delete": {
- "description": "Removes a hold by ID. This will release any HeldAccounts on this Hold.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "matterId",
- "holdId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "matterId": {
- "description": "The matter ID.",
- "required": true,
- "type": "string",
- "location": "path"
+ "resources": {
+ "accounts": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "matterId",
+ "holdId",
+ "accountId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "accountId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The ID of the account to remove from the hold."
+ },
+ "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/{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."
},
- "holdId": {
- "location": "path",
- "description": "The hold 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"
- },
- "get": {
- "flatPath": "v1/matters/{matterId}/holds/{holdId}",
- "path": "v1/matters/{matterId}/holds/{holdId}",
- "id": "vault.matters.holds.get",
- "description": "Gets a hold by ID.",
- "response": {
- "$ref": "Hold"
- },
- "parameterOrder": [
- "matterId",
- "holdId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery",
- "https://www.googleapis.com/auth/ediscovery.readonly"
- ],
- "parameters": {
- "holdId": {
- "description": "The hold ID.",
- "required": true,
- "type": "string",
- "location": "path"
+ "list": {
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery",
+ "https://www.googleapis.com/auth/ediscovery.readonly"
+ ],
+ "parameters": {
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string"
+ },
+ "holdId": {
+ "location": "path",
+ "description": "The hold ID.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
},
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "required": true,
- "type": "string"
+ "create": {
+ "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}/accounts",
+ "path": "v1/matters/{matterId}/holds/{holdId}/accounts",
+ "id": "vault.matters.holds.accounts.create",
+ "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.",
+ "response": {
+ "$ref": "HeldAccount"
+ },
+ "parameterOrder": [
+ "matterId",
+ "holdId"
+ ],
+ "httpMethod": "POST"
}
}
- },
- "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": {
- "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"
- },
- "pageToken": {
- "location": "query",
- "description": "The pagination token as returned in the response.\nAn empty token means start from the beginning.",
- "type": "string"
- }
- },
- "flatPath": "v1/matters/{matterId}/holds",
- "path": "v1/matters/{matterId}/holds",
- "id": "vault.matters.holds.list"
- },
- "update": {
- "response": {
- "$ref": "Hold"
- },
- "parameterOrder": [
- "matterId",
- "holdId"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "matterId": {
- "description": "The matter ID.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "holdId": {
- "location": "path",
- "description": "The ID of the hold.",
- "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.update",
+ }
+ },
+ "methods": {
+ "create": {
"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."
- },
- "create": {
+ "description": "Creates a hold in the given matter.",
"httpMethod": "POST",
"parameterOrder": [
"matterId"
@@ -449,121 +429,140 @@
],
"flatPath": "v1/matters/{matterId}/holds",
"id": "vault.matters.holds.create",
+ "path": "v1/matters/{matterId}/holds"
+ },
+ "delete": {
+ "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",
+ "parameters": {
+ "matterId": {
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "holdId": {
+ "description": "The hold ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery"
+ ]
+ },
+ "get": {
+ "response": {
+ "$ref": "Hold"
+ },
+ "parameterOrder": [
+ "matterId",
+ "holdId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery",
+ "https://www.googleapis.com/auth/ediscovery.readonly"
+ ],
+ "parameters": {
+ "holdId": {
+ "location": "path",
+ "description": "The hold ID.",
+ "required": true,
+ "type": "string"
+ },
+ "matterId": {
+ "location": "path",
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/matters/{matterId}/holds/{holdId}",
+ "path": "v1/matters/{matterId}/holds/{holdId}",
+ "id": "vault.matters.holds.get",
+ "description": "Gets a hold by ID."
+ },
+ "list": {
"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.",
+ "response": {
+ "$ref": "ListHoldsResponse"
+ },
+ "parameterOrder": [
+ "matterId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/ediscovery",
+ "https://www.googleapis.com/auth/ediscovery.readonly"
+ ],
+ "parameters": {
+ "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": {
+ "description": "The matter ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The pagination token as returned in the response.\nAn empty token means start from the beginning.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/matters/{matterId}/holds"
+ },
+ "update": {
+ "response": {
+ "$ref": "Hold"
+ },
+ "parameterOrder": [
+ "matterId",
+ "holdId"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "holdId": {
+ "description": "The ID of the hold.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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.update",
"request": {
"$ref": "Hold"
},
- "description": "Creates a hold in the given matter."
- }
- },
- "resources": {
- "accounts": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "matterId",
- "holdId",
- "accountId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "required": true,
- "type": "string"
- },
- "holdId": {
- "description": "The hold ID.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "accountId": {
- "location": "path",
- "description": "The ID of the account to remove from the hold.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "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": {
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery",
- "https://www.googleapis.com/auth/ediscovery.readonly"
- ],
- "parameters": {
- "matterId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The matter ID."
- },
- "holdId": {
- "location": "path",
- "description": "The hold ID.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts"
- },
- "create": {
- "path": "v1/matters/{matterId}/holds/{holdId}/accounts",
- "id": "vault.matters.holds.accounts.create",
- "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.",
- "response": {
- "$ref": "HeldAccount"
- },
- "parameterOrder": [
- "matterId",
- "holdId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "holdId": {
- "description": "The hold ID.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "matterId": {
- "location": "path",
- "description": "The matter ID.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/ediscovery"
- ],
- "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts"
- }
- }
+ "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."
}
}
}
@@ -571,6 +570,27 @@
}
},
"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": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
@@ -606,56 +626,35 @@
"location": "query"
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "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"
},
"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": {
- "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"
- },
- "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": {
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "description": "OAuth 2.0 token for the current user.",
"type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
}
},
"version": "v1",
@@ -670,23 +669,106 @@
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
- "HeldOrgUnit": {
+ "ListMattersResponse": {
+ "description": "Provides the list of matters.",
+ "type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Page token to retrieve the next page of results in the list.",
+ "type": "string"
+ },
+ "matters": {
+ "description": "List of matters.",
+ "type": "array",
+ "items": {
+ "$ref": "Matter"
+ }
+ }
+ },
+ "id": "ListMattersResponse"
+ },
+ "HeldMailQuery": {
+ "description": "Query options for mail holds.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "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"
+ }
+ },
+ "id": "HeldMailQuery"
+ },
+ "CloseMatterResponse": {
+ "properties": {
+ "matter": {
+ "$ref": "Matter",
+ "description": "The updated matter, with state CLOSED."
+ }
+ },
+ "id": "CloseMatterResponse",
+ "description": "Response to a CloseMatterRequest.",
+ "type": "object"
+ },
+ "HeldDriveQuery": {
+ "description": "Query options for drive holds.",
+ "type": "object",
+ "properties": {
+ "includeTeamDriveFiles": {
+ "description": "If true, include files in Team Drives in the hold.",
+ "type": "boolean"
+ }
+ },
+ "id": "HeldDriveQuery"
+ },
+ "HeldGroupsQuery": {
+ "properties": {
+ "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": {
+ "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"
+ }
+ },
+ "id": "HeldGroupsQuery",
+ "description": "Query options for group holds.",
+ "type": "object"
+ },
+ "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"
+ },
"holdTime": {
"description": "When the org unit was put on hold. This property is immutable.",
"format": "google-datetime",
"type": "string"
- },
- "orgUnitId": {
- "description": "The org unit's immutable ID as provided by the admin SDK.",
- "type": "string"
}
},
- "id": "HeldOrgUnit",
- "description": "A organizational unit being held in a particular hold.\nThis structure is immutable.",
- "type": "object"
+ "id": "HeldOrgUnit"
},
"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": {
"sendEmails": {
@@ -702,8 +784,7 @@
"type": "boolean"
}
},
- "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."
+ "id": "AddMatterPermissionsRequest"
},
"Matter": {
"properties": {
@@ -724,8 +805,8 @@
"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.",
@@ -752,8 +833,8 @@
"type": "object",
"properties": {
"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.",
@@ -764,6 +845,7 @@
"id": "HeldAccount"
},
"ReopenMatterResponse": {
+ "type": "object",
"properties": {
"matter": {
"description": "The updated matter, with state OPEN.",
@@ -771,8 +853,7 @@
}
},
"id": "ReopenMatterResponse",
- "description": "Response to a ReopenMatterRequest.",
- "type": "object"
+ "description": "Response to a ReopenMatterRequest."
},
"CorpusQuery": {
"description": "Corpus specific queries.",
@@ -787,28 +868,30 @@
"description": "Details pertaining to Groups holds. If set, corpus must be Groups."
},
"driveQuery": {
- "$ref": "HeldDriveQuery",
- "description": "Details pertaining to Drive holds. If set, corpus must be Drive."
+ "description": "Details pertaining to Drive holds. If set, corpus must be Drive.",
+ "$ref": "HeldDriveQuery"
}
},
"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.",
+ "type": "object",
"properties": {
"accounts": {
- "description": "If set, the hold applies to the enumerated accounts and org_unit must be\nempty.",
"type": "array",
"items": {
"$ref": "HeldAccount"
- }
+ },
+ "description": "If set, the hold applies to the enumerated accounts and org_unit must be\nempty."
},
"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."
},
"query": {
- "$ref": "CorpusQuery",
- "description": "The corpus-specific query. If set, the corpusQuery must match corpus\ntype."
+ "description": "The corpus-specific query. If set, the corpusQuery must match corpus\ntype.",
+ "$ref": "CorpusQuery"
},
"corpus": {
"enumDescriptions": [
@@ -836,45 +919,43 @@
"type": "string"
},
"name": {
- "type": "string",
- "description": "The name of the hold."
+ "description": "The name of the hold.",
+ "type": "string"
}
},
- "id": "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.",
- "type": "object"
+ "id": "Hold"
},
"ListHoldsResponse": {
- "id": "ListHoldsResponse",
- "description": "The holds for a matter.",
- "type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "Page token to retrieve the next page of results in the list.\nIf this is empty, then there are no more holds to list.",
+ "type": "string"
+ },
"holds": {
"description": "The list of holds.",
"type": "array",
"items": {
"$ref": "Hold"
}
- },
- "nextPageToken": {
- "description": "Page token to retrieve the next page of results in the list.\nIf this is empty, then there are no more holds to list.",
- "type": "string"
}
- }
+ },
+ "id": "ListHoldsResponse",
+ "description": "The holds for a matter.",
+ "type": "object"
},
"ListHeldAccountsResponse": {
- "id": "ListHeldAccountsResponse",
- "description": "Returns a list of held accounts for a hold.",
"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",
+ "description": "Returns a list of held accounts for a hold."
},
"UndeleteMatterRequest": {
"properties": {},
@@ -912,111 +993,29 @@
"id": "RemoveMatterPermissionsRequest"
},
"MatterPermission": {
+ "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.",
+ "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": {
+ "enum": [
+ "ROLE_UNSPECIFIED",
+ "COLLABORATOR",
+ "OWNER"
+ ],
"description": "The user's role in this matter.",
"type": "string",
"enumDescriptions": [
"No role assigned.",
"A collaborator to the matter.",
"The owner of the matter."
- ],
- "enum": [
- "ROLE_UNSPECIFIED",
- "COLLABORATOR",
- "OWNER"
]
}
- },
- "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.",
- "type": "object"
- },
- "ListMattersResponse": {
- "description": "Provides the list of matters.",
- "type": "object",
- "properties": {
- "matters": {
- "description": "List of matters.",
- "type": "array",
- "items": {
- "$ref": "Matter"
- }
- },
- "nextPageToken": {
- "description": "Page token to retrieve the next page of results in the list.",
- "type": "string"
- }
- },
- "id": "ListMattersResponse"
- },
- "HeldMailQuery": {
- "id": "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"
- },
- "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"
- }
}
- },
- "CloseMatterResponse": {
- "type": "object",
- "properties": {
- "matter": {
- "$ref": "Matter",
- "description": "The updated matter, with state CLOSED."
- }
- },
- "id": "CloseMatterResponse",
- "description": "Response to a CloseMatterRequest."
- },
- "HeldDriveQuery": {
- "description": "Query options for drive holds.",
- "type": "object",
- "properties": {
- "includeTeamDriveFiles": {
- "type": "boolean",
- "description": "If true, include files in Team Drives in the hold."
- }
- },
- "id": "HeldDriveQuery"
- },
- "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": {
- "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": "HeldGroupsQuery"
}
},
"protocol": "rest",
@@ -1042,5 +1041,6 @@
"name": "vault",
"batchPath": "batch",
"fullyEncodeReservedExpansion": true,
- "title": "Google Vault API"
+ "title": "Google Vault API",
+ "ownerName": "Google"
}
diff --git a/videointelligence/v1beta1/videointelligence-api.json b/videointelligence/v1beta1/videointelligence-api.json
index 6f2ed68..66317c5 100644
--- a/videointelligence/v1beta1/videointelligence-api.json
+++ b/videointelligence/v1beta1/videointelligence-api.json
@@ -1,8 +1,4 @@
{
- "rootUrl": "https://videointelligence.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "videointelligence",
- "batchPath": "batch",
"fullyEncodeReservedExpansion": true,
"title": "Cloud Video Intelligence API",
"ownerName": "Google",
@@ -15,48 +11,22 @@
},
"parameterOrder": [],
"httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {},
"flatPath": "v1beta1/videos:annotate",
"path": "v1beta1/videos:annotate",
"id": "videointelligence.videos.annotate",
- "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).",
"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)."
}
}
}
},
"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": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
@@ -70,7 +40,18 @@
"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",
@@ -78,18 +59,12 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
+ "default": "json"
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"key": {
"location": "query",
@@ -107,15 +82,36 @@
"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",
+ "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"
}
},
"version": "v1beta1",
@@ -125,11 +121,318 @@
"servicePath": "",
"basePath": "",
"revision": "20171122",
- "documentationLink": "https://cloud.google.com/video-intelligence/docs/",
"id": "videointelligence:v1beta1",
+ "documentationLink": "https://cloud.google.com/video-intelligence/docs/",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame": {
+ "description": "Video frame level annotation results for explicit content.",
+ "type": "object",
+ "properties": {
+ "pornographyLikelihood": {
+ "enumDescriptions": [
+ "Unspecified likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ],
+ "enum": [
+ "LIKELIHOOD_UNSPECIFIED",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood of the pornography content..",
+ "type": "string"
+ },
+ "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_ExplicitContentFrame"
+ },
+ "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest": {
+ "description": "Video annotation request.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "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": {
+ "description": "Additional video context and/or feature-specific parameters.",
+ "$ref": "GoogleCloudVideointelligenceV1beta1_VideoContext"
+ },
+ "locationId": {
+ "description": "Optional cloud region where annotation should take place. Supported cloud\nregions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region\nis specified, a region will be determined based on video file location.",
+ "type": "string"
+ },
+ "inputUri": {
+ "description": "Input video location. Currently, only\n[Google Cloud Storage](https://cloud.google.com/storage/) URIs are\nsupported, 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).\nA video URI may include wildcards in `object-id`, and thus identify\nmultiple videos. Supported wildcards: '*' to match 0 or more characters;\n'?' to match 1 character. If unset, the input video should be embedded\nin the request as `input_content`. If set, `input_content` should be unset.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest"
+ },
+ "GoogleCloudVideointelligenceV1beta1_VideoSegment": {
+ "id": "GoogleCloudVideointelligenceV1beta1_VideoSegment",
+ "description": "Video segment.",
+ "type": "object",
+ "properties": {
+ "endTimeOffset": {
+ "description": "End offset in microseconds (inclusive). Unset means 0.",
+ "format": "int64",
+ "type": "string"
+ },
+ "startTimeOffset": {
+ "description": "Start offset in microseconds (inclusive). Unset means 0.",
+ "format": "int64",
+ "type": "string"
+ }
+ }
+ },
+ "GoogleCloudVideointelligenceV1beta2_LabelSegment": {
+ "type": "object",
+ "properties": {
+ "segment": {
+ "description": "Video segment where a label was detected.",
+ "$ref": "GoogleCloudVideointelligenceV1beta2_VideoSegment"
+ },
+ "confidence": {
+ "description": "Confidence that the label is accurate. Range: [0, 1].",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta2_LabelSegment",
+ "description": "Video segment level annotation results for label detection."
+ },
+ "GoogleCloudVideointelligenceV1beta2_LabelAnnotation": {
+ "description": "Label annotation.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "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."
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta2_LabelAnnotation"
+ },
+ "GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation": {
+ "type": "object",
+ "properties": {
+ "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."
+ ]
+ },
+ "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": {
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Likelihood of violent content.",
+ "type": "string"
+ },
+ "medical": {
+ "description": "Likelihood of medical content.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "Very unlikely.",
+ "Unlikely.",
+ "Possible.",
+ "Likely.",
+ "Very likely."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ]
+ }
+ },
+ "id": "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."
+ },
+ "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"
+ },
+ "GoogleCloudVideointelligenceV1_Entity": {
+ "description": "Detected entity from video analysis.",
+ "type": "object",
+ "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"
+ },
+ "GoogleCloudVideointelligenceV1beta2_Entity": {
+ "description": "Detected entity from video analysis.",
+ "type": "object",
+ "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": "GoogleCloudVideointelligenceV1beta2_Entity"
+ },
"GoogleCloudVideointelligenceV1beta2_VideoSegment": {
"description": "Video segment.",
"type": "object",
@@ -151,6 +454,13 @@
"description": "Annotation results for a single video.",
"type": "object",
"properties": {
+ "shotAnnotations": {
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1_VideoSegment"
+ },
+ "description": "Shot annotations. Each shot is represented as a video segment."
+ },
"shotLabelAnnotations": {
"description": "Label annotations on shot level.\nThere is exactly one element for each unique label.",
"type": "array",
@@ -159,8 +469,8 @@
}
},
"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.",
@@ -183,18 +493,12 @@
"items": {
"$ref": "GoogleCloudVideointelligenceV1_LabelAnnotation"
}
- },
- "shotAnnotations": {
- "description": "Shot annotations. Each shot is represented as a video segment.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1_VideoSegment"
- }
}
},
"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": {
@@ -205,17 +509,12 @@
"$ref": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults"
}
}
- },
- "id": "GoogleCloudVideointelligenceV1beta2_AnnotateVideoResponse"
+ }
},
"GoogleCloudVideointelligenceV1beta1_LabelAnnotation": {
"description": "Label annotation.",
"type": "object",
"properties": {
- "languageCode": {
- "description": "Language code for `description` in BCP-47 format.",
- "type": "string"
- },
"description": {
"description": "Textual description, e.g. `Fixed-gear bicycle`.",
"type": "string"
@@ -226,63 +525,21 @@
"items": {
"$ref": "GoogleCloudVideointelligenceV1beta1_LabelLocation"
}
+ },
+ "languageCode": {
+ "description": "Language code for `description` in BCP-47 format.",
+ "type": "string"
}
},
"id": "GoogleCloudVideointelligenceV1beta1_LabelAnnotation"
},
- "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"
- },
- "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"
- },
- "safeSearchDetectionModel": {
- "description": "Model to use for safe search detection.\nSupported values: \"latest\" and \"stable\" (the default).",
- "type": "string"
- },
- "segments": {
- "description": "Video segments to annotate. The segments may overlap and are not required\nto be contiguous or span the whole video. If unspecified, each video\nis treated as a single segment.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1beta1_VideoSegment"
- }
- },
- "labelDetectionModel": {
- "description": "Model to use for label detection.\nSupported values: \"latest\" and \"stable\" (the default).",
- "type": "string"
- }
- },
- "id": "GoogleCloudVideointelligenceV1beta1_VideoContext"
- },
"GoogleCloudVideointelligenceV1_LabelAnnotation": {
"description": "Label annotation.",
"type": "object",
"properties": {
"entity": {
- "description": "Detected entity.",
- "$ref": "GoogleCloudVideointelligenceV1_Entity"
+ "$ref": "GoogleCloudVideointelligenceV1_Entity",
+ "description": "Detected entity."
},
"frames": {
"description": "All video frames where a label was detected.",
@@ -308,10 +565,65 @@
},
"id": "GoogleCloudVideointelligenceV1_LabelAnnotation"
},
- "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.",
+ "GoogleCloudVideointelligenceV1beta1_VideoContext": {
+ "description": "Video context and/or feature-specific parameters.",
"type": "object",
"properties": {
+ "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"
+ },
+ "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"
+ },
+ "safeSearchDetectionModel": {
+ "description": "Model to use for safe search detection.\nSupported values: \"latest\" and \"stable\" (the default).",
+ "type": "string"
+ },
+ "segments": {
+ "description": "Video segments to annotate. The segments may overlap and are not required\nto be contiguous or span the whole video. If unspecified, each video\nis treated as a single segment.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta1_VideoSegment"
+ }
+ },
+ "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"
+ }
+ },
+ "id": "GoogleCloudVideointelligenceV1beta1_VideoContext"
+ },
+ "GoogleRpc_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": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ }
+ }
+ },
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
@@ -320,23 +632,13 @@
"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": "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"
},
"GoogleCloudVideointelligenceV1_VideoSegment": {
- "description": "Video segment.",
"type": "object",
"properties": {
"endTimeOffset": {
@@ -350,7 +652,8 @@
"type": "string"
}
},
- "id": "GoogleCloudVideointelligenceV1_VideoSegment"
+ "id": "GoogleCloudVideointelligenceV1_VideoSegment",
+ "description": "Video segment."
},
"GoogleCloudVideointelligenceV1_LabelFrame": {
"description": "Video frame level annotation results for label detection.",
@@ -370,27 +673,10 @@
"id": "GoogleCloudVideointelligenceV1_LabelFrame"
},
"GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults": {
+ "id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults",
"description": "Annotation results for a single video.",
"type": "object",
"properties": {
- "explicitAnnotation": {
- "$ref": "GoogleCloudVideointelligenceV1beta2_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": "GoogleCloudVideointelligenceV1beta2_LabelAnnotation"
- }
- },
- "shotAnnotations": {
- "description": "Shot annotations. Each shot is represented as a video segment.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVideointelligenceV1beta2_VideoSegment"
- }
- },
"shotLabelAnnotations": {
"description": "Label annotations on shot level.\nThere is exactly one element for each unique label.",
"type": "array",
@@ -412,14 +698,33 @@
"inputUri": {
"description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
"type": "string"
+ },
+ "explicitAnnotation": {
+ "description": "Explicit content annotation.",
+ "$ref": "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation"
+ },
+ "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": "GoogleCloudVideointelligenceV1beta2_LabelAnnotation"
+ }
+ },
+ "shotAnnotations": {
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVideointelligenceV1beta2_VideoSegment"
+ },
+ "description": "Shot annotations. Each shot is represented as a video segment."
}
- },
- "id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults"
+ }
},
"GoogleCloudVideointelligenceV1beta1_LabelLocation": {
- "description": "Label location.",
- "type": "object",
"properties": {
+ "segment": {
+ "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).",
+ "$ref": "GoogleCloudVideointelligenceV1beta1_VideoSegment"
+ },
"level": {
"description": "Label level.",
"type": "string",
@@ -442,17 +747,13 @@
"description": "Confidence that the label is accurate. Range: [0, 1].",
"format": "float",
"type": "number"
- },
- "segment": {
- "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).",
- "$ref": "GoogleCloudVideointelligenceV1beta1_VideoSegment"
}
},
- "id": "GoogleCloudVideointelligenceV1beta1_LabelLocation"
+ "id": "GoogleCloudVideointelligenceV1beta1_LabelLocation",
+ "description": "Label location.",
+ "type": "object"
},
"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.",
@@ -462,21 +763,23 @@
}
}
},
- "id": "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation"
+ "id": "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"
},
"GoogleCloudVideointelligenceV1beta2_LabelFrame": {
"description": "Video frame level annotation results for label detection.",
"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"
+ },
+ "confidence": {
+ "description": "Confidence that the label is accurate. Range: [0, 1].",
+ "format": "float",
+ "type": "number"
}
},
"id": "GoogleCloudVideointelligenceV1beta2_LabelFrame"
@@ -486,6 +789,14 @@
"type": "object",
"properties": {
"pornographyLikelihood": {
+ "enum": [
+ "LIKELIHOOD_UNSPECIFIED",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
"description": "Likelihood of the pornography content..",
"type": "string",
"enumDescriptions": [
@@ -495,14 +806,6 @@
"Possible.",
"Likely.",
"Very likely."
- ],
- "enum": [
- "LIKELIHOOD_UNSPECIFIED",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
]
},
"timeOffset": {
@@ -528,8 +831,6 @@
"id": "GoogleCloudVideointelligenceV1_ExplicitContentAnnotation"
},
"GoogleCloudVideointelligenceV1beta2_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`.",
@@ -539,12 +840,25 @@
}
}
},
- "id": "GoogleCloudVideointelligenceV1beta2_AnnotateVideoProgress"
+ "id": "GoogleCloudVideointelligenceV1beta2_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"
},
"GoogleCloudVideointelligenceV1_VideoAnnotationProgress": {
+ "id": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress",
"description": "Annotation progress for a single video.",
"type": "object",
"properties": {
+ "updateTime": {
+ "description": "Time of the most recent update.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "type": "string",
+ "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"
@@ -553,21 +867,11 @@
"description": "Approximate percentage processed thus far.\nGuaranteed to be 100 when fully processed.",
"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": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress"
+ }
},
"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.",
"type": "object",
"properties": {
@@ -578,43 +882,42 @@
"$ref": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress"
}
}
- },
- "id": "GoogleCloudVideointelligenceV1_AnnotateVideoProgress"
+ }
},
"GoogleLongrunning_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"
- }
+ },
+ "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"
}
},
- "id": "GoogleLongrunning_Operation"
+ "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.",
@@ -635,20 +938,21 @@
"type": "string"
},
"startTime": {
+ "type": "string",
"description": "Time when the request was received.",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
}
},
"id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress"
},
"GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults": {
+ "id": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults",
"description": "Annotation results for a single video.",
"type": "object",
"properties": {
"error": {
- "description": "If set, indicates an error. Note that for a single `AnnotateVideoRequest`\nsome videos may succeed and some may fail.",
- "$ref": "GoogleRpc_Status"
+ "$ref": "GoogleRpc_Status",
+ "description": "If set, indicates an error. Note that for a single `AnnotateVideoRequest`\nsome videos may succeed and some may fail."
},
"shotAnnotations": {
"description": "Shot annotations. Each shot is represented as a video segment.",
@@ -675,8 +979,7 @@
"$ref": "GoogleCloudVideointelligenceV1beta1_LabelAnnotation"
}
}
- },
- "id": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults"
+ }
},
"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.",
@@ -710,26 +1013,21 @@
"description": "Video segment level annotation results for label detection.",
"type": "object",
"properties": {
- "segment": {
- "description": "Video segment where a label was detected.",
- "$ref": "GoogleCloudVideointelligenceV1_VideoSegment"
- },
"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": "GoogleCloudVideointelligenceV1_LabelSegment"
},
"GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress": {
- "description": "Annotation progress for a single video.",
"type": "object",
"properties": {
- "inputUri": {
- "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.",
"format": "int32",
@@ -744,322 +1042,20 @@
"description": "Time when the request was received.",
"format": "google-datetime",
"type": "string"
- }
- },
- "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.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ],
- "enum": [
- "LIKELIHOOD_UNSPECIFIED",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ]
- },
- "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_ExplicitContentFrame"
- },
- "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest": {
- "description": "Video annotation request.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
- },
- "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."
- ]
- },
- "videoContext": {
- "$ref": "GoogleCloudVideointelligenceV1beta1_VideoContext",
- "description": "Additional video context and/or feature-specific parameters."
- },
- "locationId": {
- "description": "Optional cloud region where annotation should take place. Supported cloud\nregions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region\nis specified, a region will be determined based on video file location.",
- "type": "string"
},
"inputUri": {
- "description": "Input video location. Currently, only\n[Google Cloud Storage](https://cloud.google.com/storage/) URIs are\nsupported, 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).\nA video URI may include wildcards in `object-id`, and thus identify\nmultiple videos. Supported wildcards: '*' to match 0 or more characters;\n'?' to match 1 character. If unset, the input video should be embedded\nin the request as `input_content`. If set, `input_content` should be unset.",
+ "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).",
"type": "string"
}
},
- "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest"
- },
- "GoogleCloudVideointelligenceV1beta1_VideoSegment": {
- "description": "Video segment.",
- "type": "object",
- "properties": {
- "endTimeOffset": {
- "description": "End offset in microseconds (inclusive). Unset means 0.",
- "format": "int64",
- "type": "string"
- },
- "startTimeOffset": {
- "description": "Start offset in microseconds (inclusive). Unset means 0.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "GoogleCloudVideointelligenceV1beta1_VideoSegment"
- },
- "GoogleCloudVideointelligenceV1beta2_LabelSegment": {
- "description": "Video segment level annotation results for label detection.",
- "type": "object",
- "properties": {
- "segment": {
- "description": "Video segment where a label was detected.",
- "$ref": "GoogleCloudVideointelligenceV1beta2_VideoSegment"
- },
- "confidence": {
- "description": "Confidence that the label is accurate. Range: [0, 1].",
- "format": "float",
- "type": "number"
- }
- },
- "id": "GoogleCloudVideointelligenceV1beta2_LabelSegment"
- },
- "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_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": {
- "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": {
- "description": "Likelihood of violent content.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "Very unlikely.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ]
- },
- "medical": {
- "description": "Likelihood of medical content.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "Very unlikely.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ]
- },
- "adult": {
- "description": "Likelihood of adult content.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "Very unlikely.",
- "Unlikely.",
- "Possible.",
- "Likely.",
- "Very likely."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ]
- },
- "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"
- }
- },
- "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"
- },
- "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"
- }
- },
- "id": "GoogleCloudVideointelligenceV1_Entity"
- },
- "GoogleCloudVideointelligenceV1beta2_Entity": {
- "description": "Detected entity from video analysis.",
- "type": "object",
- "properties": {
- "description": {
- "description": "Textual description, e.g. `Fixed-gear bicycle`.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "GoogleCloudVideointelligenceV1beta2_Entity"
+ "id": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress",
+ "description": "Annotation progress for a single video."
}
},
"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 Video Intelligence",
"auth": {
@@ -1070,5 +1066,9 @@
}
}
}
- }
+ },
+ "rootUrl": "https://videointelligence.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "videointelligence",
+ "batchPath": "batch"
}
diff --git a/vision/v1/vision-api.json b/vision/v1/vision-api.json
index ad430e3..5460eb6 100644
--- a/vision/v1/vision-api.json
+++ b/vision/v1/vision-api.json
@@ -1,136 +1,68 @@
{
- "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": {
- "flatPath": "v1/images:annotate",
- "path": "v1/images:annotate",
- "id": "vision.images.annotate",
- "request": {
- "$ref": "BatchAnnotateImagesRequest"
- },
- "description": "Run image detection and annotation for a batch of images.",
- "response": {
- "$ref": "BatchAnnotateImagesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-vision"
- ]
- }
- }
- }
- },
- "parameters": {
- "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": {
- "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": {
- "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": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "$.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://vision.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
- "servicePath": "",
- "basePath": "",
- "id": "vision:v1",
- "documentationLink": "https://cloud.google.com/vision/",
- "revision": "20171107",
"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"
+ },
+ "Symbol": {
+ "description": "A single symbol representation.",
+ "type": "object",
+ "properties": {
+ "text": {
+ "description": "The actual UTF-8 representation of the symbol.",
+ "type": "string"
+ },
+ "property": {
+ "description": "Additional information detected for the symbol.",
+ "$ref": "TextProperty"
+ },
+ "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"
+ }
+ },
+ "id": "Symbol"
+ },
+ "LatLongRect": {
+ "description": "Rectangle determined by min and max `LatLng` pairs.",
+ "type": "object",
+ "properties": {
+ "maxLatLng": {
+ "$ref": "LatLng",
+ "description": "Max lat/long pair."
+ },
+ "minLatLng": {
+ "$ref": "LatLng",
+ "description": "Min lat/long pair."
+ }
+ },
+ "id": "LatLongRect"
+ },
"CropHintsAnnotation": {
"description": "Set of crop hints that are used to generate new crops when serving images.",
"type": "object",
@@ -149,13 +81,13 @@
"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].",
+ "latitude": {
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
"format": "double",
"type": "number"
},
- "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"
}
@@ -163,6 +95,8 @@
"id": "LatLng"
},
"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].",
@@ -185,15 +119,26 @@
"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"
+ "id": "Color"
},
"Feature": {
"description": "Users describe the type of Google Cloud Vision API tasks to perform over\nimages by using *Feature*s. Each Feature indicates a type of image\ndetection task to perform. Features encode the Cloud Vision API\nvertical to operate on and the number of top-scoring results to return.",
"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": [
@@ -208,19 +153,6 @@
"Compute a set of image properties, such as the image'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"
]
},
"maxResults": {
@@ -243,7 +175,6 @@
"id": "ImageProperties"
},
"SafeSearchAnnotation": {
- "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).",
"type": "object",
"properties": {
@@ -268,6 +199,14 @@
]
},
"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": [
@@ -277,25 +216,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"
]
},
"medical": {
- "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",
@@ -305,7 +228,15 @@
"VERY_LIKELY"
],
"description": "Likelihood that this is a medical image.",
- "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."
+ ]
},
"violence": {
"description": "Likelihood that this image contains violent content.",
@@ -327,7 +258,8 @@
"VERY_LIKELY"
]
}
- }
+ },
+ "id": "SafeSearchAnnotation"
},
"DominantColorsAnnotation": {
"description": "Set of dominant colors and their corresponding scores.",
@@ -344,7 +276,6 @@
"id": "DominantColorsAnnotation"
},
"TextAnnotation": {
- "type": "object",
"properties": {
"pages": {
"description": "List of pages detected by OCR.",
@@ -354,28 +285,13 @@
}
},
"text": {
- "type": "string",
- "description": "UTF-8 text detected on the pages."
+ "description": "UTF-8 text detected on the pages.",
+ "type": "string"
}
},
"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": {
- "type": "string",
- "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."
- }
- },
- "id": "DetectedLanguage"
+ "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"
},
"Vertex": {
"description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.",
@@ -394,12 +310,26 @@
},
"id": "Vertex"
},
- "WebEntity": {
+ "DetectedLanguage": {
+ "description": "Detected language for a structural component.",
+ "type": "object",
"properties": {
- "entityId": {
- "description": "Opaque entity ID.",
+ "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"
+ }
+ },
+ "id": "DetectedLanguage"
+ },
+ "WebEntity": {
+ "description": "Entity deduced from similar images on the Internet.",
+ "type": "object",
+ "properties": {
"description": {
"description": "Canonical description of the entity, in English.",
"type": "string"
@@ -408,11 +338,13 @@
"description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.",
"format": "float",
"type": "number"
+ },
+ "entityId": {
+ "description": "Opaque entity ID.",
+ "type": "string"
}
},
- "id": "WebEntity",
- "description": "Entity deduced from similar images on the Internet.",
- "type": "object"
+ "id": "WebEntity"
},
"BoundingPoly": {
"description": "A bounding polygon for the detected image annotation.",
@@ -429,72 +361,25 @@
"id": "BoundingPoly"
},
"TextProperty": {
- "description": "Additional information detected on the structural component.",
- "type": "object",
"properties": {
+ "detectedBreak": {
+ "$ref": "DetectedBreak",
+ "description": "Detected start or end of a text segment."
+ },
"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."
}
},
- "id": "TextProperty"
+ "id": "TextProperty",
+ "description": "Additional information detected on the structural component.",
+ "type": "object"
},
"AnnotateImageResponse": {
- "id": "AnnotateImageResponse",
- "description": "Response to an image annotation request.",
- "type": "object",
"properties": {
- "textAnnotations": {
- "description": "If present, text (OCR) detection has completed successfully.",
- "type": "array",
- "items": {
- "$ref": "EntityAnnotation"
- }
- },
- "imagePropertiesAnnotation": {
- "description": "If present, image properties were extracted successfully.",
- "$ref": "ImageProperties"
- },
- "faceAnnotations": {
- "description": "If present, face detection has completed successfully.",
- "type": "array",
- "items": {
- "$ref": "FaceAnnotation"
- }
- },
- "logoAnnotations": {
- "type": "array",
- "items": {
- "$ref": "EntityAnnotation"
- },
- "description": "If present, logo detection has completed successfully."
- },
- "cropHintsAnnotation": {
- "$ref": "CropHintsAnnotation",
- "description": "If present, crop hints have completed successfully."
- },
- "webDetection": {
- "$ref": "WebDetection",
- "description": "If present, web detection has completed successfully."
- },
- "labelAnnotations": {
- "description": "If present, label detection has completed successfully.",
- "type": "array",
- "items": {
- "$ref": "EntityAnnotation"
- }
- },
- "safeSearchAnnotation": {
- "description": "If present, safe-search annotation has completed successfully.",
- "$ref": "SafeSearchAnnotation"
- },
"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."
@@ -509,10 +394,58 @@
"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",
+ "items": {
+ "$ref": "FaceAnnotation"
+ }
+ },
+ "imagePropertiesAnnotation": {
+ "description": "If present, image properties were extracted successfully.",
+ "$ref": "ImageProperties"
+ },
+ "logoAnnotations": {
+ "description": "If present, logo detection has completed successfully.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityAnnotation"
+ }
+ },
+ "cropHintsAnnotation": {
+ "description": "If present, crop hints have completed successfully.",
+ "$ref": "CropHintsAnnotation"
+ },
+ "webDetection": {
+ "description": "If present, web detection has completed successfully.",
+ "$ref": "WebDetection"
+ },
+ "labelAnnotations": {
+ "description": "If present, label detection has completed successfully.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityAnnotation"
+ }
+ },
+ "safeSearchAnnotation": {
+ "$ref": "SafeSearchAnnotation",
+ "description": "If present, safe-search annotation has completed successfully."
}
- }
+ },
+ "id": "AnnotateImageResponse",
+ "description": "Response to an image annotation request.",
+ "type": "object"
},
"CropHintsParams": {
+ "description": "Parameters for crop hints annotation request.",
"type": "object",
"properties": {
"aspectRatios": {
@@ -524,18 +457,29 @@
}
}
},
- "id": "CropHintsParams",
- "description": "Parameters for crop hints annotation request."
+ "id": "CropHintsParams"
},
"Block": {
"description": "Logical element on the page.",
"type": "object",
"properties": {
+ "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 * 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)."
+ },
+ "paragraphs": {
+ "description": "List of paragraphs in this block (if this blocks is of type text).",
+ "type": "array",
+ "items": {
+ "$ref": "Paragraph"
+ }
+ },
"property": {
- "description": "Additional information detected for the block.",
- "$ref": "TextProperty"
+ "$ref": "TextProperty",
+ "description": "Additional information detected for the block."
},
"blockType": {
+ "description": "Detected block type (text, image etc) for this block.",
"type": "string",
"enumDescriptions": [
"Unknown block type.",
@@ -552,25 +496,12 @@
"PICTURE",
"RULER",
"BARCODE"
- ],
- "description": "Detected block type (text, image etc) for this 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 * 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"
- },
- "paragraphs": {
- "description": "List of paragraphs in this block (if this blocks is of type text).",
- "type": "array",
- "items": {
- "$ref": "Paragraph"
- }
+ ]
}
},
"id": "Block"
},
"Property": {
- "type": "object",
"properties": {
"value": {
"description": "Value of the property.",
@@ -587,67 +518,24 @@
}
},
"id": "Property",
- "description": "A `Property` consists of a user-supplied name/value pair."
+ "description": "A `Property` consists of a user-supplied name/value pair.",
+ "type": "object"
},
"LocationInfo": {
"description": "Detected entity location information.",
"type": "object",
"properties": {
"latLng": {
- "description": "lat/long location coordinates.",
- "$ref": "LatLng"
+ "$ref": "LatLng",
+ "description": "lat/long location coordinates."
}
},
"id": "LocationInfo"
},
- "ImageSource": {
- "type": "object",
- "properties": {
- "gcsImageUri": {
- "type": "string",
- "description": "NOTE: For new code `image_uri` below is preferred.\nGoogle Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported."
- },
- "imageUri": {
- "type": "string",
- "description": "Image URI which supports:\n1) Google Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.\n2) Publicly accessible image HTTP/HTTPS URL.\nThis is preferred over the legacy `gcs_image_uri` above. When both\n`gcs_image_uri` and `image_uri` are specified, `image_uri` takes\nprecedence."
- }
- },
- "id": "ImageSource",
- "description": "External image source (Google Cloud Storage image location)."
- },
- "BatchAnnotateImagesResponse": {
- "id": "BatchAnnotateImagesResponse",
- "description": "Response to a batch image annotation request.",
- "type": "object",
- "properties": {
- "responses": {
- "type": "array",
- "items": {
- "$ref": "AnnotateImageResponse"
- },
- "description": "Individual responses to image annotation requests within the batch."
- }
- }
- },
"WebDetection": {
- "id": "WebDetection",
"description": "Relevant information for the image from the Internet.",
"type": "object",
"properties": {
- "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",
- "items": {
- "$ref": "WebImage"
- }
- },
- "visuallySimilarImages": {
- "description": "The visually similar image results.",
- "type": "array",
- "items": {
- "$ref": "WebImage"
- }
- },
"fullMatchingImages": {
"description": "Fully matching images from the Internet.\nCan include resized copies of the query image.",
"type": "array",
@@ -668,12 +556,54 @@
"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",
+ "items": {
+ "$ref": "WebImage"
+ }
+ },
+ "visuallySimilarImages": {
+ "description": "The visually similar image results.",
+ "type": "array",
+ "items": {
+ "$ref": "WebImage"
+ }
}
- }
+ },
+ "id": "WebDetection"
+ },
+ "BatchAnnotateImagesResponse": {
+ "description": "Response to a batch image annotation request.",
+ "type": "object",
+ "properties": {
+ "responses": {
+ "description": "Individual responses to image annotation requests within the batch.",
+ "type": "array",
+ "items": {
+ "$ref": "AnnotateImageResponse"
+ }
+ }
+ },
+ "id": "BatchAnnotateImagesResponse"
+ },
+ "ImageSource": {
+ "description": "External image source (Google Cloud Storage image location).",
+ "type": "object",
+ "properties": {
+ "gcsImageUri": {
+ "description": "NOTE: For new code `image_uri` below is preferred.\nGoogle Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.",
+ "type": "string"
+ },
+ "imageUri": {
+ "description": "Image URI which supports:\n1) Google Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.\n2) Publicly accessible image HTTP/HTTPS URL.\nThis is preferred over the legacy `gcs_image_uri` above. When both\n`gcs_image_uri` and `image_uri` are specified, `image_uri` takes\nprecedence.",
+ "type": "string"
+ }
+ },
+ "id": "ImageSource"
},
"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": {
"x": {
"description": "X coordinate.",
@@ -681,9 +611,9 @@
"type": "number"
},
"z": {
- "type": "number",
"description": "Z coordinate (or depth).",
- "format": "float"
+ "format": "float",
+ "type": "number"
},
"y": {
"description": "Y coordinate.",
@@ -691,25 +621,12 @@
"type": "number"
}
},
- "id": "Position"
- },
- "WebPage": {
- "description": "Metadata for web pages.",
- "type": "object",
- "properties": {
- "score": {
- "description": "(Deprecated) Overall relevancy score for the web page.",
- "format": "float",
- "type": "number"
- },
- "url": {
- "description": "The result web page URL.",
- "type": "string"
- }
- },
- "id": "WebPage"
+ "id": "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"
},
"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": {
"pixelFraction": {
@@ -718,8 +635,8 @@
"type": "number"
},
"color": {
- "description": "RGB components of the color.",
- "$ref": "Color"
+ "$ref": "Color",
+ "description": "RGB components of the color."
},
"score": {
"description": "Image-specific score for this color. Value in range [0, 1].",
@@ -727,8 +644,23 @@
"type": "number"
}
},
- "id": "ColorInfo",
- "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image."
+ "id": "ColorInfo"
+ },
+ "WebPage": {
+ "description": "Metadata for web pages.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "The result web page URL.",
+ "type": "string"
+ },
+ "score": {
+ "description": "(Deprecated) Overall relevancy score for the web page.",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "WebPage"
},
"EntityAnnotation": {
"description": "Set of detected entity features.",
@@ -783,8 +715,6 @@
"id": "EntityAnnotation"
},
"CropHint": {
- "description": "Single crop hint that is used to generate a new crop when serving an image.",
- "type": "object",
"properties": {
"confidence": {
"description": "Confidence of this being a salient region. Range [0, 1].",
@@ -801,16 +731,14 @@
"$ref": "BoundingPoly"
}
},
- "id": "CropHint"
+ "id": "CropHint",
+ "description": "Single crop hint that is used to generate a new crop when serving an image.",
+ "type": "object"
},
"Landmark": {
"description": "A face-specific landmark (for example, a face feature).",
"type": "object",
"properties": {
- "position": {
- "$ref": "Position",
- "description": "Face landmark position."
- },
"type": {
"enum": [
"UNKNOWN_LANDMARK",
@@ -888,33 +816,37 @@
"Chin left gonion.",
"Chin right gonion."
]
+ },
+ "position": {
+ "$ref": "Position",
+ "description": "Face landmark position."
}
},
"id": "Landmark"
},
"WebImage": {
- "id": "WebImage",
"description": "Metadata for online images.",
"type": "object",
"properties": {
+ "url": {
+ "description": "The result image URL.",
+ "type": "string"
+ },
"score": {
"description": "(Deprecated) Overall relevancy score for the image.",
"format": "float",
"type": "number"
- },
- "url": {
- "type": "string",
- "description": "The result image URL."
}
- }
+ },
+ "id": "WebImage"
},
"Word": {
"description": "A word representation.",
"type": "object",
"properties": {
"boundingBox": {
- "$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)."
+ "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"
},
"symbols": {
"description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.",
@@ -930,28 +862,6 @@
},
"id": "Word"
},
- "Paragraph": {
- "id": "Paragraph",
- "description": "Structural unit of text representing a number of words in certain order.",
- "type": "object",
- "properties": {
- "property": {
- "$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": {
- "description": "List of words in this paragraph.",
- "type": "array",
- "items": {
- "$ref": "Word"
- }
- }
- }
- },
"Image": {
"description": "Client image to perform Google Cloud Vision API tasks over.",
"type": "object",
@@ -968,97 +878,41 @@
},
"id": "Image"
},
+ "Paragraph": {
+ "description": "Structural unit of text representing a number of words in certain order.",
+ "type": "object",
+ "properties": {
+ "property": {
+ "$ref": "TextProperty",
+ "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": "BoundingPoly"
+ },
+ "words": {
+ "description": "List of words in this paragraph.",
+ "type": "array",
+ "items": {
+ "$ref": "Word"
+ }
+ }
+ },
+ "id": "Paragraph"
+ },
"FaceAnnotation": {
"description": "A face annotation object contains the results of face detection.",
"type": "object",
"properties": {
- "fdBoundingPoly": {
- "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": "BoundingPoly"
- },
- "surpriseLikelihood": {
- "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": "Surprise likelihood.",
- "type": "string"
- },
- "landmarks": {
- "description": "Detected face landmarks.",
- "type": "array",
- "items": {
- "$ref": "Landmark"
- }
- },
- "angerLikelihood": {
- "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": "Anger likelihood."
- },
- "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",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Joy likelihood.",
- "type": "string"
- },
- "detectionConfidence": {
- "description": "Detection confidence. Range [0, 1].",
- "format": "float",
- "type": "number"
- },
- "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"
- },
"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",
@@ -1068,18 +922,19 @@
"VERY_LIKELY"
],
"description": "Under-exposed 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."
- ]
+ "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": {
- "type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely that the image belongs to the specified vertical.",
@@ -1096,11 +951,10 @@
"LIKELY",
"VERY_LIKELY"
],
- "description": "Blurred likelihood."
+ "description": "Blurred likelihood.",
+ "type": "string"
},
"headwearLikelihood": {
- "description": "Headwear likelihood.",
- "type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely that the image belongs to the specified vertical.",
@@ -1116,11 +970,13 @@
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
- ]
+ ],
+ "description": "Headwear likelihood.",
+ "type": "string"
},
"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."
+ "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"
},
"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].",
@@ -1128,8 +984,6 @@
"type": "number"
},
"sorrowLikelihood": {
- "description": "Sorrow likelihood.",
- "type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely that the image belongs to the specified vertical.",
@@ -1145,18 +999,95 @@
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
- ]
+ ],
+ "description": "Sorrow likelihood.",
+ "type": "string"
},
"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."
+ },
+ "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": "Landmark"
+ }
+ },
+ "surpriseLikelihood": {
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Surprise 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."
+ ]
+ },
+ "landmarkingConfidence": {
+ "description": "Face landmarking confidence. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "joyLikelihood": {
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Joy 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."
+ ]
}
},
"id": "FaceAnnotation"
},
"BatchAnnotateImagesRequest": {
- "id": "BatchAnnotateImagesRequest",
"description": "Multiple image annotation requests are batched into a single service call.",
"type": "object",
"properties": {
@@ -1167,13 +1098,16 @@
"$ref": "AnnotateImageRequest"
}
}
- }
+ },
+ "id": "BatchAnnotateImagesRequest"
},
"DetectedBreak": {
"description": "Detected start or end of a structural component.",
"type": "object",
"properties": {
"type": {
+ "description": "Detected break type.",
+ "type": "string",
"enumDescriptions": [
"Unknown break label type.",
"Regular space.",
@@ -1189,9 +1123,7 @@
"EOL_SURE_SPACE",
"HYPHEN",
"LINE_BREAK"
- ],
- "description": "Detected break type.",
- "type": "string"
+ ]
},
"isPrefix": {
"description": "True if break prepends the element.",
@@ -1204,6 +1136,13 @@
"description": "Image context and/or feature-specific parameters.",
"type": "object",
"properties": {
+ "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"
+ }
+ },
"latLongRect": {
"$ref": "LatLongRect",
"description": "lat/long rectangle that specifies the location of the image."
@@ -1211,25 +1150,12 @@
"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"
- }
}
},
"id": "ImageContext"
},
"Page": {
- "description": "Detected page from OCR.",
- "type": "object",
"properties": {
- "property": {
- "$ref": "TextProperty",
- "description": "Additional information detected on the page."
- },
"height": {
"description": "Page height in pixels.",
"format": "int32",
@@ -1241,14 +1167,20 @@
"type": "integer"
},
"blocks": {
+ "description": "List of blocks of text, images etc on this page.",
"type": "array",
"items": {
"$ref": "Block"
- },
- "description": "List of blocks of text, images etc on this page."
+ }
+ },
+ "property": {
+ "description": "Additional information detected on the page.",
+ "$ref": "TextProperty"
}
},
- "id": "Page"
+ "id": "Page",
+ "description": "Detected page from OCR.",
+ "type": "object"
},
"AnnotateImageRequest": {
"description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features.",
@@ -1266,90 +1198,158 @@
}
},
"imageContext": {
- "$ref": "ImageContext",
- "description": "Additional context that may accompany the image."
+ "description": "Additional context that may accompany the image.",
+ "$ref": "ImageContext"
}
},
"id": "AnnotateImageRequest"
- },
- "Status": {
- "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": {
- "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."
- },
- "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."
- },
- "LatLongRect": {
- "description": "Rectangle determined by min and max `LatLng` pairs.",
- "type": "object",
- "properties": {
- "minLatLng": {
- "$ref": "LatLng",
- "description": "Min lat/long pair."
- },
- "maxLatLng": {
- "description": "Max lat/long pair.",
- "$ref": "LatLng"
- }
- },
- "id": "LatLongRect"
- },
- "Symbol": {
- "type": "object",
- "properties": {
- "property": {
- "$ref": "TextProperty",
- "description": "Additional information detected for the symbol."
- },
- "boundingBox": {
- "$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)."
- },
- "text": {
- "description": "The actual UTF-8 representation of the symbol.",
- "type": "string"
- }
- },
- "id": "Symbol",
- "description": "A single symbol representation."
}
},
"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": "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"
+ },
+ "https://www.googleapis.com/auth/cloud-vision": {
+ "description": "Apply machine learning models to understand and label images"
}
}
}
- }
+ },
+ "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": {
+ "response": {
+ "$ref": "BatchAnnotateImagesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-vision"
+ ],
+ "flatPath": "v1/images:annotate",
+ "path": "v1/images:annotate",
+ "id": "vision.images.annotate",
+ "request": {
+ "$ref": "BatchAnnotateImagesRequest"
+ },
+ "description": "Run image detection and annotation for a batch of images."
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "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"
+ },
+ "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": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://vision.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "vision:v1",
+ "documentationLink": "https://cloud.google.com/vision/",
+ "revision": "20171107"
}
diff --git a/vision/v1p1beta1/vision-api.json b/vision/v1p1beta1/vision-api.json
index 68e96d2..7b6850b 100644
--- a/vision/v1p1beta1/vision-api.json
+++ b/vision/v1p1beta1/vision-api.json
@@ -1,13 +1,68 @@
{
+ "version": "v1p1beta1",
+ "baseUrl": "https://vision.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
+ "servicePath": "",
"basePath": "",
- "revision": "20171107",
- "documentationLink": "https://cloud.google.com/vision/",
"id": "vision:v1p1beta1",
+ "documentationLink": "https://cloud.google.com/vision/",
+ "revision": "20171107",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
+ "GoogleCloudVisionV1p1beta1Symbol": {
+ "type": "object",
+ "properties": {
+ "text": {
+ "type": "string",
+ "description": "The actual UTF-8 representation of the symbol."
+ },
+ "property": {
+ "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
+ "description": "Additional information detected for the symbol."
+ },
+ "boundingBox": {
+ "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
+ "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)."
+ },
+ "confidence": {
+ "type": "number",
+ "description": "Confidence of the OCR results for the symbol. Range [0, 1].",
+ "format": "float"
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1Symbol",
+ "description": "A single symbol representation."
+ },
+ "GoogleCloudVisionV1p1beta1ImageProperties": {
+ "description": "Stores image properties, such as dominant colors.",
+ "type": "object",
+ "properties": {
+ "dominantColors": {
+ "$ref": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation",
+ "description": "If present, dominant colors completed successfully."
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1ImageProperties"
+ },
+ "GoogleCloudVisionV1p1beta1Image": {
+ "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"
+ },
+ "source": {
+ "$ref": "GoogleCloudVisionV1p1beta1ImageSource",
+ "description": "Google Cloud Storage image location. If both `content` and `source`\nare provided for an image, `content` takes precedence and is\nused to perform the image annotation request."
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1Image"
+ },
"GoogleCloudVisionV1p1beta1ColorInfo": {
- "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.",
"type": "object",
"properties": {
"pixelFraction": {
@@ -16,8 +71,8 @@
"type": "number"
},
"color": {
- "description": "RGB components of the color.",
- "$ref": "Color"
+ "$ref": "Color",
+ "description": "RGB components of the color."
},
"score": {
"description": "Image-specific score for this color. Value in range [0, 1].",
@@ -25,68 +80,34 @@
"type": "number"
}
},
- "id": "GoogleCloudVisionV1p1beta1ColorInfo"
+ "id": "GoogleCloudVisionV1p1beta1ColorInfo",
+ "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image."
},
"GoogleCloudVisionV1p1beta1WebDetectionWebEntity": {
- "description": "Entity deduced from similar images on the Internet.",
"type": "object",
"properties": {
- "entityId": {
- "description": "Opaque entity ID.",
- "type": "string"
- },
- "description": {
- "description": "Canonical description of the entity, in English.",
- "type": "string"
- },
"score": {
"description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.",
"format": "float",
"type": "number"
+ },
+ "entityId": {
+ "type": "string",
+ "description": "Opaque entity ID."
+ },
+ "description": {
+ "description": "Canonical description of the entity, in English.",
+ "type": "string"
}
},
- "id": "GoogleCloudVisionV1p1beta1WebDetectionWebEntity"
+ "id": "GoogleCloudVisionV1p1beta1WebDetectionWebEntity",
+ "description": "Entity deduced from similar images on the Internet."
},
"GoogleCloudVisionV1p1beta1FaceAnnotationLandmark": {
+ "description": "A face-specific landmark (for example, a face feature).",
+ "type": "object",
"properties": {
"type": {
- "enumDescriptions": [
- "Unknown face landmark detected. Should not be filled.",
- "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."
- ],
"enum": [
"UNKNOWN_LANDMARK",
"LEFT_EYE",
@@ -125,27 +146,62 @@
"CHIN_RIGHT_GONION"
],
"description": "Face landmark type.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown face landmark detected. Should not be filled.",
+ "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."
+ ]
},
"position": {
"$ref": "GoogleCloudVisionV1p1beta1Position",
"description": "Face landmark position."
}
},
- "id": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark",
- "description": "A face-specific landmark (for example, a face feature).",
- "type": "object"
+ "id": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark"
},
"GoogleCloudVisionV1p1beta1WebDetection": {
"description": "Relevant information for the image from the Internet.",
"type": "object",
"properties": {
"visuallySimilarImages": {
- "description": "The visually similar image results.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage"
- }
+ },
+ "description": "The visually similar image results."
},
"bestGuessLabels": {
"description": "Best guess text labels for the request image.",
@@ -162,11 +218,11 @@
}
},
"webEntities": {
- "description": "Deduced entities from similar images on the Internet.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebEntity"
- }
+ },
+ "description": "Deduced entities from similar images on the Internet."
},
"pagesWithMatchingImages": {
"description": "Web pages containing the matching images from the Internet.",
@@ -176,21 +232,19 @@
}
},
"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",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage"
- }
+ },
+ "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."
}
},
"id": "GoogleCloudVisionV1p1beta1WebDetection"
},
"GoogleCloudVisionV1p1beta1AnnotateImageResponse": {
+ "description": "Response to an image annotation request.",
+ "type": "object",
"properties": {
- "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."
- },
"landmarkAnnotations": {
"description": "If present, landmark detection has completed successfully.",
"type": "array",
@@ -205,16 +259,16 @@
"$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation"
}
},
- "imagePropertiesAnnotation": {
- "description": "If present, image properties were extracted successfully.",
- "$ref": "GoogleCloudVisionV1p1beta1ImageProperties"
- },
"faceAnnotations": {
- "description": "If present, face detection has completed successfully.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1FaceAnnotation"
- }
+ },
+ "description": "If present, face detection has completed successfully."
+ },
+ "imagePropertiesAnnotation": {
+ "$ref": "GoogleCloudVisionV1p1beta1ImageProperties",
+ "description": "If present, image properties were extracted successfully."
},
"logoAnnotations": {
"description": "If present, logo detection has completed successfully.",
@@ -228,8 +282,8 @@
"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.",
@@ -245,16 +299,264 @@
"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": {
+ "$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",
- "description": "Response to an image annotation request.",
- "type": "object"
+ "id": "GoogleCloudVisionV1p1beta1AnnotateImageResponse"
},
- "GoogleCloudVisionV1p1beta1SafeSearchAnnotation": {
- "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).",
+ "GoogleCloudVisionV1p1beta1FaceAnnotation": {
"type": "object",
"properties": {
+ "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."
+ },
+ "angerLikelihood": {
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "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."
+ ]
+ },
+ "landmarks": {
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark"
+ },
+ "description": "Detected face landmarks."
+ },
+ "surpriseLikelihood": {
+ "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": "Surprise likelihood."
+ },
+ "joyLikelihood": {
+ "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": "Joy likelihood."
+ },
+ "landmarkingConfidence": {
+ "type": "number",
+ "description": "Face landmarking confidence. Range [0, 1].",
+ "format": "float"
+ },
+ "detectionConfidence": {
+ "type": "number",
+ "description": "Detection confidence. Range [0, 1].",
+ "format": "float"
+ },
+ "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"
+ },
+ "underExposedLikelihood": {
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Under-exposed 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."
+ ]
+ },
+ "blurredLikelihood": {
+ "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": "Blurred likelihood."
+ },
+ "headwearLikelihood": {
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ],
+ "description": "Headwear 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."
+ ]
+ },
+ "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": {
+ "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"
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1FaceAnnotation",
+ "description": "A face annotation object contains the results of face detection."
+ },
+ "GoogleCloudVisionV1p1beta1SafeSearchAnnotation": {
+ "type": "object",
+ "properties": {
+ "racy": {
+ "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 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."
+ },
+ "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."
+ },
+ "adult": {
+ "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": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities."
+ },
"spoof": {
"enum": [
"UNKNOWN",
@@ -276,14 +578,6 @@
]
},
"medical": {
- "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",
@@ -293,38 +587,6 @@
"VERY_LIKELY"
],
"description": "Likelihood that this is a medical image.",
- "type": "string"
- },
- "racy": {
- "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 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.",
@@ -334,233 +596,15 @@
"It is likely that the image belongs to the specified vertical.",
"It is very likely that the image belongs to the specified vertical."
]
- },
- "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"
}
},
- "id": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation"
- },
- "GoogleCloudVisionV1p1beta1FaceAnnotation": {
- "description": "A face annotation object contains the results of face detection.",
- "type": "object",
- "properties": {
- "underExposedLikelihood": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Under-exposed 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."
- ]
- },
- "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": [
- "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."
- ]
- },
- "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",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Headwear likelihood.",
- "type": "string"
- },
- "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": {
- "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": "Sorrow likelihood.",
- "type": "string"
- },
- "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."
- },
- "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": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Surprise 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."
- ]
- },
- "joyLikelihood": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Joy 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."
- ]
- },
- "landmarkingConfidence": {
- "description": "Face landmarking confidence. Range [0, 1].",
- "format": "float",
- "type": "number"
- }
- },
- "id": "GoogleCloudVisionV1p1beta1FaceAnnotation"
+ "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)."
},
"GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak": {
+ "type": "object",
"properties": {
- "isPrefix": {
- "description": "True if break prepends the element.",
- "type": "boolean"
- },
"type": {
- "enum": [
- "UNKNOWN",
- "SPACE",
- "SURE_SPACE",
- "EOL_SURE_SPACE",
- "HYPHEN",
- "LINE_BREAK"
- ],
- "description": "Detected break type.",
"type": "string",
"enumDescriptions": [
"Unknown break label type.",
@@ -569,69 +613,49 @@
"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",
+ "SURE_SPACE",
+ "EOL_SURE_SPACE",
+ "HYPHEN",
+ "LINE_BREAK"
+ ],
+ "description": "Detected break type."
+ },
+ "isPrefix": {
+ "type": "boolean",
+ "description": "True if break prepends the element."
}
},
"id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak",
- "description": "Detected start or end of a structural component.",
- "type": "object"
+ "description": "Detected start or end of a structural component."
},
"GoogleCloudVisionV1p1beta1AnnotateImageRequest": {
"description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features.",
"type": "object",
"properties": {
- "imageContext": {
- "$ref": "GoogleCloudVisionV1p1beta1ImageContext",
- "description": "Additional context that may accompany the image."
- },
"image": {
"$ref": "GoogleCloudVisionV1p1beta1Image",
"description": "The image to be processed."
},
"features": {
- "description": "Requested features.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Feature"
- }
+ },
+ "description": "Requested features."
+ },
+ "imageContext": {
+ "$ref": "GoogleCloudVisionV1p1beta1ImageContext",
+ "description": "Additional context that may accompany the image."
}
},
"id": "GoogleCloudVisionV1p1beta1AnnotateImageRequest"
},
- "GoogleCloudVisionV1p1beta1Page": {
- "description": "Detected page from OCR.",
- "type": "object",
- "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"
- },
"GoogleCloudVisionV1p1beta1Block": {
+ "type": "object",
"properties": {
"property": {
"$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
@@ -667,18 +691,51 @@
"type": "number"
},
"paragraphs": {
- "description": "List of paragraphs in this block (if this blocks is of type text).",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Paragraph"
- }
+ },
+ "description": "List of paragraphs in this block (if this blocks is of type text)."
}
},
"id": "GoogleCloudVisionV1p1beta1Block",
- "description": "Logical element on the page.",
- "type": "object"
+ "description": "Logical element on the page."
+ },
+ "GoogleCloudVisionV1p1beta1Page": {
+ "description": "Detected page from OCR.",
+ "type": "object",
+ "properties": {
+ "width": {
+ "description": "Page width in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "blocks": {
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVisionV1p1beta1Block"
+ },
+ "description": "List of blocks of text, images etc on this page."
+ },
+ "property": {
+ "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
+ "description": "Additional information detected on the page."
+ },
+ "confidence": {
+ "type": "number",
+ "description": "Confidence of the OCR results on the page. Range [0, 1].",
+ "format": "float"
+ },
+ "height": {
+ "description": "Page height in pixels.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1Page"
},
"GoogleCloudVisionV1p1beta1Paragraph": {
+ "type": "object",
"properties": {
"boundingBox": {
"$ref": "GoogleCloudVisionV1p1beta1BoundingPoly",
@@ -702,11 +759,9 @@
}
},
"id": "GoogleCloudVisionV1p1beta1Paragraph",
- "description": "Structural unit of text representing a number of words in certain order.",
- "type": "object"
+ "description": "Structural unit of text representing a number of words in certain order."
},
"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": {
@@ -721,22 +776,28 @@
"type": "string"
}
},
- "id": "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."
},
"GoogleCloudVisionV1p1beta1EntityAnnotation": {
"description": "Set of detected entity features.",
"type": "object",
"properties": {
+ "score": {
+ "description": "Overall score of the result. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
"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": "GoogleCloudVisionV1p1beta1LocationInfo"
- }
+ },
+ "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": "The 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].",
@@ -751,56 +812,71 @@
"description": "The language code for the locale in which the entity textual\n`description` is expressed.",
"type": "string"
},
+ "description": {
+ "type": "string",
+ "description": "Entity textual description, expressed in its `locale` language."
+ },
"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": "GoogleCloudVisionV1p1beta1Property"
}
- },
- "score": {
- "description": "Overall score of the result. Range [0, 1].",
- "format": "float",
- "type": "number"
}
},
"id": "GoogleCloudVisionV1p1beta1EntityAnnotation"
},
"GoogleCloudVisionV1p1beta1BoundingPoly": {
+ "description": "A bounding polygon for the detected image annotation.",
+ "type": "object",
"properties": {
"vertices": {
- "description": "The bounding polygon vertices.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1Vertex"
- }
+ },
+ "description": "The bounding polygon vertices."
}
},
- "id": "GoogleCloudVisionV1p1beta1BoundingPoly",
- "description": "A bounding polygon for the detected image annotation.",
- "type": "object"
+ "id": "GoogleCloudVisionV1p1beta1BoundingPoly"
},
- "GoogleCloudVisionV1p1beta1WebDetectionParams": {
+ "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty": {
+ "description": "Additional information detected on the structural component.",
+ "type": "object",
"properties": {
- "includeGeoResults": {
- "description": "Whether to include results derived from the geo information in the image.",
- "type": "boolean"
+ "detectedBreak": {
+ "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak",
+ "description": "Detected start or end of a text segment."
+ },
+ "detectedLanguages": {
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage"
+ },
+ "description": "A list of detected languages together with confidence."
}
},
- "id": "GoogleCloudVisionV1p1beta1WebDetectionParams",
- "description": "Parameters for web detection request.",
- "type": "object"
+ "id": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty"
+ },
+ "GoogleCloudVisionV1p1beta1LocationInfo": {
+ "description": "Detected entity location information.",
+ "type": "object",
+ "properties": {
+ "latLng": {
+ "$ref": "LatLng",
+ "description": "lat/long location coordinates."
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1LocationInfo"
},
"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.",
@@ -810,77 +886,53 @@
}
}
},
- "id": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest",
- "description": "Multiple image annotation requests are batched into a single service call.",
- "type": "object"
+ "id": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest"
},
- "GoogleCloudVisionV1p1beta1LocationInfo": {
+ "GoogleCloudVisionV1p1beta1WebDetectionParams": {
+ "description": "Parameters for web detection request.",
+ "type": "object",
"properties": {
- "latLng": {
- "description": "lat/long location coordinates.",
- "$ref": "LatLng"
+ "includeGeoResults": {
+ "description": "Whether to include results derived from the geo information in the image.",
+ "type": "boolean"
}
},
- "id": "GoogleCloudVisionV1p1beta1LocationInfo",
- "description": "Detected entity location information.",
- "type": "object"
- },
- "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty": {
- "properties": {
- "detectedLanguages": {
- "description": "A list of detected languages together with confidence.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage"
- }
- },
- "detectedBreak": {
- "description": "Detected start or end of a text segment.",
- "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak"
- }
- },
- "id": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
- "description": "Additional information detected on the structural component.",
- "type": "object"
+ "id": "GoogleCloudVisionV1p1beta1WebDetectionParams"
},
"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": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
+ "type": "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": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "type": "object"
+ }
}
},
"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"
+ "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."
},
"GoogleCloudVisionV1p1beta1Word": {
"description": "A word representation.",
"type": "object",
"properties": {
- "property": {
- "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
- "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": "GoogleCloudVisionV1p1beta1BoundingPoly"
+ "$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].",
@@ -888,16 +940,21 @@
"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"
- }
+ },
+ "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order."
+ },
+ "property": {
+ "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty",
+ "description": "Additional information detected for the word."
}
},
"id": "GoogleCloudVisionV1p1beta1Word"
},
"GoogleCloudVisionV1p1beta1CropHintsParams": {
+ "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.",
@@ -909,23 +966,22 @@
}
},
"id": "GoogleCloudVisionV1p1beta1CropHintsParams",
- "description": "Parameters for crop hints annotation request.",
- "type": "object"
+ "description": "Parameters for crop hints annotation request."
},
"GoogleCloudVisionV1p1beta1ImageSource": {
- "description": "External image source (Google Cloud Storage image location).",
"type": "object",
"properties": {
+ "imageUri": {
+ "type": "string",
+ "description": "Image URI which supports:\n1) Google Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.\n2) Publicly accessible image HTTP/HTTPS URL.\nThis is preferred over the legacy `gcs_image_uri` above. When both\n`gcs_image_uri` and `image_uri` are specified, `image_uri` takes\nprecedence."
+ },
"gcsImageUri": {
"description": "NOTE: For new code `image_uri` below is preferred.\nGoogle Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.",
"type": "string"
- },
- "imageUri": {
- "description": "Image URI which supports:\n1) Google Cloud Storage image URI, which must be in the following form:\n`gs://bucket_name/object_name` (for details, see\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris)).\nNOTE: Cloud Storage object versioning is not supported.\n2) Publicly accessible image HTTP/HTTPS URL.\nThis is preferred over the legacy `gcs_image_uri` above. When both\n`gcs_image_uri` and `image_uri` are specified, `image_uri` takes\nprecedence.",
- "type": "string"
}
},
- "id": "GoogleCloudVisionV1p1beta1ImageSource"
+ "id": "GoogleCloudVisionV1p1beta1ImageSource",
+ "description": "External image source (Google Cloud Storage image location)."
},
"GoogleCloudVisionV1p1beta1LatLongRect": {
"description": "Rectangle determined by min and max `LatLng` pairs.",
@@ -977,17 +1033,6 @@
"description": "Metadata for web pages.",
"type": "object",
"properties": {
- "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"
- },
"pageTitle": {
"description": "Title for the web page, may contain HTML markups.",
"type": "string"
@@ -1003,30 +1048,46 @@
"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"
},
- "GoogleCloudVisionV1p1beta1Feature": {
+ "GoogleCloudVisionV1p1beta1CropHint": {
+ "description": "Single crop hint that is used to generate a new crop when serving an image.",
+ "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"
+ "confidence": {
+ "description": "Confidence of this being a salient region. Range [0, 1].",
+ "format": "float",
+ "type": "number"
},
+ "importanceFraction": {
+ "type": "number",
+ "description": "Fraction of importance of this salient region with respect to the original\nimage.",
+ "format": "float"
+ },
+ "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`."
+ }
+ },
+ "id": "GoogleCloudVisionV1p1beta1CropHint"
+ },
+ "GoogleCloudVisionV1p1beta1Feature": {
+ "type": "object",
+ "properties": {
"type": {
- "enumDescriptions": [
- "Unspecified feature type.",
- "Run face detection.",
- "Run landmark detection.",
- "Run logo detection.",
- "Run label detection.",
- "Run OCR.",
- "Run dense text document OCR. Takes precedence when both\nDOCUMENT_TEXT_DETECTION and TEXT_DETECTION are present.",
- "Run computer vision models to compute image safe-search properties.",
- "Compute a set of image properties, such as the image's dominant colors.",
- "Run crop hints.",
- "Run web detection."
- ],
"enum": [
"TYPE_UNSPECIFIED",
"FACE_DETECTION",
@@ -1041,38 +1102,33 @@
"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 OCR.",
+ "Run dense text document OCR. Takes precedence when both\nDOCUMENT_TEXT_DETECTION and TEXT_DETECTION are present.",
+ "Run computer vision models to compute image safe-search properties.",
+ "Compute a set of image properties, such as the image's dominant colors.",
+ "Run crop hints.",
+ "Run web detection."
+ ]
},
"maxResults": {
+ "type": "integer",
"description": "Maximum number of results of this type.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
+ },
+ "model": {
+ "type": "string",
+ "description": "Model to use for the feature.\nSupported values: \"builtin/stable\" (the default if unset) and\n\"builtin/latest\"."
}
},
"id": "GoogleCloudVisionV1p1beta1Feature",
- "description": "Users describe the type of Google Cloud Vision API tasks to perform over\nimages by using *Feature*s. Each Feature indicates a type of image\ndetection task to perform. Features encode the Cloud Vision API\nvertical to operate on and the number of top-scoring results to return.",
- "type": "object"
- },
- "GoogleCloudVisionV1p1beta1CropHint": {
- "description": "Single crop hint that is used to generate a new crop when serving an image.",
- "type": "object",
- "properties": {
- "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"
- },
- "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": "GoogleCloudVisionV1p1beta1CropHint"
+ "description": "Users describe the type of Google Cloud Vision API tasks to perform over\nimages by using *Feature*s. Each Feature indicates a type of image\ndetection task to perform. Features encode the Cloud Vision API\nvertical to operate on and the number of top-scoring results to return."
},
"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.",
@@ -1092,29 +1148,28 @@
"id": "LatLng"
},
"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": {
- "y": {
- "description": "Y coordinate.",
- "format": "float",
- "type": "number"
- },
"x": {
+ "type": "number",
"description": "X coordinate.",
- "format": "float",
- "type": "number"
+ "format": "float"
},
"z": {
"description": "Z coordinate (or depth).",
"format": "float",
"type": "number"
+ },
+ "y": {
+ "type": "number",
+ "description": "Y coordinate.",
+ "format": "float"
}
},
- "id": "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."
},
"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": {
@@ -1128,38 +1183,36 @@
"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": {
+ "type": "number",
"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"
+ "format": "float"
}
},
- "id": "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 // ..."
},
"GoogleCloudVisionV1p1beta1CropHintsAnnotation": {
- "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": "GoogleCloudVisionV1p1beta1CropHint"
- }
+ },
+ "description": "Crop hint results."
}
},
- "id": "GoogleCloudVisionV1p1beta1CropHintsAnnotation"
+ "id": "GoogleCloudVisionV1p1beta1CropHintsAnnotation",
+ "description": "Set of crop hints that are used to generate new crops when serving images."
},
"GoogleCloudVisionV1p1beta1Property": {
+ "type": "object",
"properties": {
- "value": {
- "description": "Value of the property.",
- "type": "string"
- },
"uint64Value": {
"description": "Value of numeric properties.",
"format": "uint64",
@@ -1168,24 +1221,18 @@
"name": {
"description": "Name of the property.",
"type": "string"
+ },
+ "value": {
+ "type": "string",
+ "description": "Value of the property."
}
},
"id": "GoogleCloudVisionV1p1beta1Property",
- "description": "A `Property` consists of a user-supplied name/value pair.",
- "type": "object"
+ "description": "A `Property` consists of a user-supplied name/value pair."
},
"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",
@@ -1194,47 +1241,57 @@
}
},
"webDetectionParams": {
- "description": "Parameters for web detection.",
- "$ref": "GoogleCloudVisionV1p1beta1WebDetectionParams"
+ "$ref": "GoogleCloudVisionV1p1beta1WebDetectionParams",
+ "description": "Parameters for web detection."
+ },
+ "latLongRect": {
+ "$ref": "GoogleCloudVisionV1p1beta1LatLongRect",
+ "description": "lat/long rectangle that specifies the location of the image."
+ },
+ "cropHintsParams": {
+ "$ref": "GoogleCloudVisionV1p1beta1CropHintsParams",
+ "description": "Parameters for crop hints annotation request."
}
},
- "id": "GoogleCloudVisionV1p1beta1ImageContext"
+ "id": "GoogleCloudVisionV1p1beta1ImageContext",
+ "description": "Image context and/or feature-specific parameters."
},
"GoogleCloudVisionV1p1beta1WebDetectionWebImage": {
- "description": "Metadata for online images.",
"type": "object",
"properties": {
- "url": {
- "description": "The result image URL.",
- "type": "string"
- },
"score": {
"description": "(Deprecated) Overall relevancy score for the image.",
"format": "float",
"type": "number"
+ },
+ "url": {
+ "type": "string",
+ "description": "The result image URL."
}
},
- "id": "GoogleCloudVisionV1p1beta1WebDetectionWebImage"
+ "id": "GoogleCloudVisionV1p1beta1WebDetectionWebImage",
+ "description": "Metadata for online images."
},
"GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse": {
"description": "Response to a batch image annotation request.",
"type": "object",
"properties": {
"responses": {
- "description": "Individual responses to image annotation requests within the batch.",
"type": "array",
"items": {
"$ref": "GoogleCloudVisionV1p1beta1AnnotateImageResponse"
- }
+ },
+ "description": "Individual responses to image annotation requests within the batch."
}
},
"id": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse"
},
"GoogleCloudVisionV1p1beta1WebDetectionWebLabel": {
+ "type": "object",
"properties": {
"label": {
- "description": "Label for extra metadata.",
- "type": "string"
+ "type": "string",
+ "description": "Label for extra metadata."
},
"languageCode": {
"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.",
@@ -1242,75 +1299,23 @@
}
},
"id": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel",
- "description": "Label to provide extra metadata for the web detection.",
- "type": "object"
+ "description": "Label to provide extra metadata for the web detection."
},
"GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage": {
"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"
+ "type": "string",
+ "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."
},
"confidence": {
+ "type": "number",
"description": "Confidence of detected language. Range [0, 1].",
- "format": "float",
- "type": "number"
+ "format": "float"
}
},
"id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage"
- },
- "GoogleCloudVisionV1p1beta1Symbol": {
- "description": "A single symbol representation.",
- "type": "object",
- "properties": {
- "property": {
- "description": "Additional information detected for the symbol.",
- "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty"
- },
- "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": "GoogleCloudVisionV1p1beta1BoundingPoly"
- },
- "confidence": {
- "description": "Confidence of the OCR results for the symbol. Range [0, 1].",
- "format": "float",
- "type": "number"
- },
- "text": {
- "description": "The actual UTF-8 representation of the symbol.",
- "type": "string"
- }
- },
- "id": "GoogleCloudVisionV1p1beta1Symbol"
- },
- "GoogleCloudVisionV1p1beta1ImageProperties": {
- "description": "Stores image properties, such as dominant colors.",
- "type": "object",
- "properties": {
- "dominantColors": {
- "description": "If present, dominant colors completed successfully.",
- "$ref": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation"
- }
- },
- "id": "GoogleCloudVisionV1p1beta1ImageProperties"
- },
- "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.",
- "format": "byte",
- "type": "string"
- },
- "source": {
- "description": "Google Cloud Storage image location. If both `content` and `source`\nare provided for an image, `content` takes precedence and is\nused to perform the image annotation request.",
- "$ref": "GoogleCloudVisionV1p1beta1ImageSource"
- }
- },
- "id": "GoogleCloudVisionV1p1beta1Image"
}
},
"protocol": "rest",
@@ -1322,11 +1327,11 @@
"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-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"
}
}
}
@@ -1342,68 +1347,74 @@
"images": {
"methods": {
"annotate": {
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-vision"
- ],
- "parameters": {},
- "flatPath": "v1p1beta1/images:annotate",
- "path": "v1p1beta1/images:annotate",
- "id": "vision.images.annotate",
- "description": "Run image detection and annotation for a batch of images.",
- "request": {
- "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest"
- }
+ ]
}
}
}
},
"parameters": {
"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": {
- "description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true",
- "location": "query"
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
},
"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."
},
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "callback": {
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "JSONP"
},
"$.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"
+ "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",
@@ -1411,18 +1422,12 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
+ "default": "json"
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"key": {
"location": "query",
@@ -1430,30 +1435,25 @@
"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"
- },
- "oauth_token": {
+ "default": "true",
"location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "description": "Pretty-print response."
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
}
- },
- "version": "v1p1beta1",
- "baseUrl": "https://vision.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
- "servicePath": ""
+ }
}
diff --git a/youtubereporting/v1/youtubereporting-api.json b/youtubereporting/v1/youtubereporting-api.json
index 398afb1..c8d1456 100644
--- a/youtubereporting/v1/youtubereporting-api.json
+++ b/youtubereporting/v1/youtubereporting-api.json
@@ -1,7 +1,30 @@
{
- "id": "youtubereporting:v1",
- "documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/",
+ "version": "v1",
+ "baseUrl": "https://youtubereporting.googleapis.com/",
+ "canonicalName": "YouTube Reporting",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/yt-analytics.readonly": {
+ "description": "View YouTube Analytics reports for your YouTube content"
+ },
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly": {
+ "description": "View monetary and non-monetary YouTube Analytics reports for your YouTube content"
+ }
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "servicePath": "",
+ "description": "Schedules reporting jobs containing your YouTube Analytics data and downloads the resulting bulk data reports in the form of CSV files.",
+ "rootUrl": "https://youtubereporting.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "youtubereporting",
+ "batchPath": "batch",
"revision": "20171213",
+ "documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/",
+ "id": "youtubereporting:v1",
"title": "YouTube Reporting API",
"discoveryVersion": "v1",
"ownerName": "Google",
@@ -11,9 +34,6 @@
"reports": {
"methods": {
"list": {
- "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.",
"response": {
"$ref": "ListReportsResponse"
},
@@ -22,11 +42,17 @@
],
"httpMethod": "GET",
"parameters": {
+ "jobId": {
+ "location": "path",
+ "description": "The ID of the job.",
+ "required": true,
+ "type": "string"
+ },
"createdAfter": {
+ "location": "query",
"description": "If set, only reports created after the specified date/time are returned.",
"format": "google-datetime",
- "type": "string",
- "location": "query"
+ "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.",
@@ -34,10 +60,10 @@
"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"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"location": "query",
@@ -46,20 +72,14 @@
"type": "integer"
},
"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",
- "location": "query"
+ "type": "string"
},
"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",
- "location": "query"
- },
- "jobId": {
- "location": "path",
- "description": "The ID of the job.",
- "required": true,
"type": "string"
}
},
@@ -67,18 +87,32 @@
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
"https://www.googleapis.com/auth/yt-analytics.readonly"
],
- "flatPath": "v1/jobs/{jobId}/reports"
+ "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."
},
"get": {
- "response": {
- "$ref": "Report"
- },
+ "description": "Gets the metadata of a specific report.",
+ "httpMethod": "GET",
"parameterOrder": [
"jobId",
"reportId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
"parameters": {
+ "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",
@@ -89,51 +123,40 @@
"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"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
"flatPath": "v1/jobs/{jobId}/reports/{reportId}",
- "path": "v1/jobs/{jobId}/reports/{reportId}",
"id": "youtubereporting.jobs.reports.get",
- "description": "Gets the metadata of a specific report."
+ "path": "v1/jobs/{jobId}/reports/{reportId}"
}
}
}
},
"methods": {
"create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "Job"
},
- "parameterOrder": [],
- "httpMethod": "POST",
- "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"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
"https://www.googleapis.com/auth/yt-analytics.readonly"
],
+ "parameters": {
+ "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"
+ }
+ },
"flatPath": "v1/jobs",
- "path": "v1/jobs",
"id": "youtubereporting.jobs.create",
+ "path": "v1/jobs",
+ "description": "Creates a job and returns it.",
"request": {
"$ref": "Job"
- },
- "description": "Creates a job and returns it."
+ }
},
"delete": {
"description": "Deletes a job.",
@@ -144,38 +167,38 @@
"jobId"
],
"httpMethod": "DELETE",
- "parameters": {
- "jobId": {
- "location": "path",
- "description": "The ID of the job to delete.",
- "required": true,
- "type": "string"
- },
- "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": [
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
"https://www.googleapis.com/auth/yt-analytics.readonly"
],
+ "parameters": {
+ "jobId": {
+ "description": "The ID of the job to delete.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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"
+ }
+ },
"flatPath": "v1/jobs/{jobId}",
"path": "v1/jobs/{jobId}",
"id": "youtubereporting.jobs.delete"
},
"list": {
+ "httpMethod": "GET",
"response": {
"$ref": "ListJobsResponse"
},
"parameterOrder": [],
- "httpMethod": "GET",
"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"
+ "type": "string",
+ "location": "query"
},
"pageToken": {
"location": "query",
@@ -188,10 +211,10 @@
"location": "query"
},
"pageSize": {
- "location": "query",
"description": "Requested page size. Server may return fewer jobs than requested.\nIf unspecified, server will pick an appropriate default.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
}
},
"scopes": [
@@ -199,29 +222,29 @@
"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": {
- "httpMethod": "GET",
- "parameterOrder": [
- "jobId"
- ],
"response": {
"$ref": "Job"
},
+ "parameterOrder": [
+ "jobId"
+ ],
+ "httpMethod": "GET",
"parameters": {
+ "jobId": {
+ "location": "path",
+ "description": "The ID of the job to retrieve.",
+ "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"
- },
- "jobId": {
- "description": "The ID of the job to retrieve.",
- "required": true,
- "type": "string",
- "location": "path"
}
},
"scopes": [
@@ -229,8 +252,8 @@
"https://www.googleapis.com/auth/yt-analytics.readonly"
],
"flatPath": "v1/jobs/{jobId}",
- "id": "youtubereporting.jobs.get",
"path": "v1/jobs/{jobId}",
+ "id": "youtubereporting.jobs.get",
"description": "Gets a job."
}
}
@@ -238,19 +261,25 @@
"reportTypes": {
"methods": {
"list": {
- "path": "v1/reportTypes",
- "id": "youtubereporting.reportTypes.list",
- "description": "Lists report types.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
"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": {
+ "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 `ListReportTypes` method.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"includeSystemManaged": {
"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.",
@@ -262,35 +291,30 @@
"description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
"format": "int32",
"type": "integer"
- },
- "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"
- ],
- "flatPath": "v1/reportTypes"
+ "flatPath": "v1/reportTypes",
+ "id": "youtubereporting.reportTypes.list",
+ "path": "v1/reportTypes",
+ "description": "Lists report types."
}
}
},
"media": {
"methods": {
"download": {
- "path": "v1/media/{+resourceName}",
- "id": "youtubereporting.media.download",
- "description": "Method for media download. Download is supported\non the URI `/v1/media/{+name}?alt=media`.",
"supportsMediaDownload": true,
- "response": {
- "$ref": "GdataMedia"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"resourceName"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "GdataMedia"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
"parameters": {
"resourceName": {
"pattern": "^.+$",
@@ -300,36 +324,24 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
- "flatPath": "v1/media/{mediaId}"
+ "flatPath": "v1/media/{mediaId}",
+ "id": "youtubereporting.media.download",
+ "path": "v1/media/{+resourceName}",
+ "description": "Method for media download. Download is supported\non the URI `/v1/media/{+name}?alt=media`."
}
}
}
},
"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"
+ "type": "string",
+ "location": "query"
},
"$.xgafv": {
"enum": [
@@ -345,17 +357,11 @@
"location": "query"
},
"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",
@@ -363,7 +369,13 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
},
"access_token": {
"description": "OAuth access token.",
@@ -387,21 +399,424 @@
"default": "true"
},
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "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": {
- "GdataObjectId": {
+ "GdataDiffVersionResponse": {
"description": "gdata",
"type": "object",
"properties": {
+ "objectSizeBytes": {
+ "description": "gdata",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectVersion": {
+ "description": "gdata",
+ "type": "string"
+ }
+ },
+ "id": "GdataDiffVersionResponse"
+ },
+ "GdataDiffDownloadResponse": {
+ "description": "gdata",
+ "type": "object",
+ "properties": {
+ "objectLocation": {
+ "$ref": "GdataCompositeMedia",
+ "description": "gdata"
+ }
+ },
+ "id": "GdataDiffDownloadResponse"
+ },
+ "GdataDiffUploadRequest": {
+ "properties": {
+ "checksumsInfo": {
+ "$ref": "GdataCompositeMedia",
+ "description": "gdata"
+ },
+ "objectVersion": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "objectInfo": {
+ "description": "gdata",
+ "$ref": "GdataCompositeMedia"
+ }
+ },
+ "id": "GdataDiffUploadRequest",
+ "description": "gdata",
+ "type": "object"
+ },
+ "GdataBlobstore2Info": {
+ "properties": {
+ "blobId": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "GdataBlobstore2Info",
+ "description": "gdata",
+ "type": "object"
+ },
+ "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": {
+ "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": {
+ "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": {
+ "properties": {
+ "referenceType": {
+ "enumDescriptions": [
+ "gdata",
+ "gdata",
+ "gdata",
+ "gdata",
+ "gdata"
+ ],
+ "enum": [
+ "PATH",
+ "BLOB_REF",
+ "INLINE",
+ "BIGSTORE_REF",
+ "COSMO_BINARY_REFERENCE"
+ ],
+ "description": "gdata",
+ "type": "string"
+ },
+ "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"
+ },
+ "sha1Hash": {
+ "description": "gdata",
+ "format": "byte",
+ "type": "string"
+ },
+ "crc32cHash": {
+ "description": "gdata",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "path": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "length": {
+ "description": "gdata",
+ "format": "int64",
+ "type": "string"
+ },
+ "cosmoBinaryReference": {
+ "description": "gdata",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "GdataCompositeMedia",
+ "description": "gdata",
+ "type": "object"
+ },
+ "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",
+ "properties": {
+ "fromFileName": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "bestGuess": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "fromUrlPath": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "fromHeader": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "fromBytes": {
+ "description": "gdata",
+ "type": "string"
+ }
+ },
+ "id": "GdataContentTypeInfo"
+ },
+ "GdataDiffUploadResponse": {
+ "properties": {
+ "objectVersion": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "originalObject": {
+ "$ref": "GdataCompositeMedia",
+ "description": "gdata"
+ }
+ },
+ "id": "GdataDiffUploadResponse",
+ "description": "gdata",
+ "type": "object"
+ },
+ "Report": {
+ "properties": {
+ "jobId": {
+ "description": "The ID of the job that created this report.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The server-generated ID of the report.",
+ "type": "string"
+ },
+ "jobExpireTime": {
+ "description": "The date/time when the job this report belongs to will expire/expired.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "The end of the time period that the report instance covers. The value is\nexclusive.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "downloadUrl": {
+ "description": "The URL from which the report can be downloaded (max. 1000 characters).",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "The start of the time period that the report instance covers. The value is\ninclusive.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "The date/time when this report was created.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Report",
+ "description": "A report's metadata including the URL from which the report itself can be\ndownloaded.",
+ "type": "object"
+ },
+ "GdataDiffChecksumsResponse": {
+ "properties": {
+ "chunkSizeBytes": {
+ "description": "gdata",
+ "format": "int64",
+ "type": "string"
+ },
+ "checksumsLocation": {
+ "description": "gdata",
+ "$ref": "GdataCompositeMedia"
+ },
+ "objectSizeBytes": {
+ "description": "gdata",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectLocation": {
+ "$ref": "GdataCompositeMedia",
+ "description": "gdata"
+ },
+ "objectVersion": {
+ "description": "gdata",
+ "type": "string"
+ }
+ },
+ "id": "GdataDiffChecksumsResponse",
+ "description": "gdata",
+ "type": "object"
+ },
+ "GdataDownloadParameters": {
+ "description": "gdata",
+ "type": "object",
+ "properties": {
+ "ignoreRange": {
+ "description": "gdata",
+ "type": "boolean"
+ },
+ "allowGzipCompression": {
+ "description": "gdata",
+ "type": "boolean"
+ }
+ },
+ "id": "GdataDownloadParameters"
+ },
+ "Job": {
+ "description": "A job creating reports of a specific type.",
+ "type": "object",
+ "properties": {
+ "createTime": {
+ "description": "The creation date/time of the job.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "reportTypeId": {
+ "description": "The type of reports this job creates. Corresponds to the ID of a\nReportType.",
+ "type": "string"
+ },
+ "expireTime": {
+ "description": "The date/time when this job will expire/expired. After a job expired, no\nnew reports are generated.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "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"
+ }
+ },
+ "id": "Job"
+ },
+ "GdataObjectId": {
+ "properties": {
+ "bucketName": {
+ "description": "gdata",
+ "type": "string"
+ },
"generation": {
"description": "gdata",
"format": "int64",
@@ -410,122 +825,30 @@
"objectName": {
"description": "gdata",
"type": "string"
- },
- "bucketName": {
- "description": "gdata",
- "type": "string"
}
},
- "id": "GdataObjectId"
+ "id": "GdataObjectId",
+ "description": "gdata",
+ "type": "object"
},
"GdataMedia": {
"description": "gdata",
"type": "object",
"properties": {
- "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": {
- "$ref": "GdataDownloadParameters",
- "description": "gdata"
- },
- "mediaId": {
- "description": "gdata",
- "format": "byte",
- "type": "string"
- },
- "compositeMedia": {
- "description": "gdata",
- "type": "array",
- "items": {
- "$ref": "GdataCompositeMedia"
- }
- },
- "blobRef": {
- "description": "gdata",
- "format": "byte",
- "type": "string"
- },
- "diffUploadResponse": {
- "$ref": "GdataDiffUploadResponse",
- "description": "gdata"
- },
- "diffVersionResponse": {
- "description": "gdata",
- "$ref": "GdataDiffVersionResponse"
- },
- "timestamp": {
- "description": "gdata",
- "format": "uint64",
- "type": "string"
- },
- "token": {
- "description": "gdata",
- "type": "string"
- },
- "hash": {
- "description": "gdata",
- "type": "string"
- },
- "filename": {
- "description": "gdata",
- "type": "string"
- },
- "blobstore2Info": {
- "$ref": "GdataBlobstore2Info",
- "description": "gdata"
- },
- "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"
},
- "sha256Hash": {
- "description": "gdata",
- "format": "byte",
- "type": "string"
- },
"objectId": {
"description": "gdata",
"$ref": "GdataObjectId"
@@ -579,187 +902,21 @@
"type": "string"
},
"diffUploadRequest": {
- "$ref": "GdataDiffUploadRequest",
- "description": "gdata"
+ "description": "gdata",
+ "$ref": "GdataDiffUploadRequest"
},
"diffChecksumsResponse": {
"description": "gdata",
"$ref": "GdataDiffChecksumsResponse"
- }
- },
- "id": "GdataMedia"
- },
- "GdataDiffVersionResponse": {
- "properties": {
- "objectSizeBytes": {
- "description": "gdata",
- "format": "int64",
- "type": "string"
- },
- "objectVersion": {
- "description": "gdata",
- "type": "string"
- }
- },
- "id": "GdataDiffVersionResponse",
- "description": "gdata",
- "type": "object"
- },
- "GdataDiffDownloadResponse": {
- "description": "gdata",
- "type": "object",
- "properties": {
- "objectLocation": {
- "$ref": "GdataCompositeMedia",
- "description": "gdata"
- }
- },
- "id": "GdataDiffDownloadResponse"
- },
- "GdataDiffUploadRequest": {
- "properties": {
- "checksumsInfo": {
- "$ref": "GdataCompositeMedia",
- "description": "gdata"
- },
- "objectVersion": {
- "description": "gdata",
- "type": "string"
- },
- "objectInfo": {
- "$ref": "GdataCompositeMedia",
- "description": "gdata"
- }
- },
- "id": "GdataDiffUploadRequest",
- "description": "gdata",
- "type": "object"
- },
- "GdataBlobstore2Info": {
- "description": "gdata",
- "type": "object",
- "properties": {
- "readToken": {
- "description": "gdata",
- "type": "string"
- },
- "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"
- }
- },
- "id": "GdataBlobstore2Info"
- },
- "ListReportTypesResponse": {
- "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",
- "description": "Response message for ReportingService.ListReportTypes.",
- "type": "object"
- },
- "ReportType": {
- "description": "A report type.",
- "type": "object",
- "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"
- },
- "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": {
- "jobs": {
- "description": "The list of jobs.",
- "type": "array",
- "items": {
- "$ref": "Job"
- }
- },
- "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"
- }
- },
- "id": "ListJobsResponse"
- },
- "GdataCompositeMedia": {
- "description": "gdata",
- "type": "object",
- "properties": {
- "blobstore2Info": {
- "$ref": "GdataBlobstore2Info",
- "description": "gdata"
- },
- "blobRef": {
- "description": "gdata",
- "format": "byte",
- "type": "string"
- },
- "objectId": {
- "$ref": "GdataObjectId",
- "description": "gdata"
- },
- "sha1Hash": {
- "description": "gdata",
- "format": "byte",
- "type": "string"
},
"crc32cHash": {
"description": "gdata",
"format": "uint32",
"type": "integer"
},
- "path": {
+ "sha1Hash": {
"description": "gdata",
+ "format": "byte",
"type": "string"
},
"length": {
@@ -767,245 +924,88 @@
"format": "int64",
"type": "string"
},
+ "contentTypeInfo": {
+ "$ref": "GdataContentTypeInfo",
+ "description": "gdata"
+ },
+ "contentType": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "downloadParameters": {
+ "$ref": "GdataDownloadParameters",
+ "description": "gdata"
+ },
+ "mediaId": {
+ "description": "gdata",
+ "format": "byte",
+ "type": "string"
+ },
+ "compositeMedia": {
+ "description": "gdata",
+ "type": "array",
+ "items": {
+ "$ref": "GdataCompositeMedia"
+ }
+ },
+ "diffUploadResponse": {
+ "$ref": "GdataDiffUploadResponse",
+ "description": "gdata"
+ },
+ "blobRef": {
+ "description": "gdata",
+ "format": "byte",
+ "type": "string"
+ },
+ "diffVersionResponse": {
+ "$ref": "GdataDiffVersionResponse",
+ "description": "gdata"
+ },
+ "timestamp": {
+ "description": "gdata",
+ "format": "uint64",
+ "type": "string"
+ },
+ "token": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "hash": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "filename": {
+ "description": "gdata",
+ "type": "string"
+ },
+ "blobstore2Info": {
+ "$ref": "GdataBlobstore2Info",
+ "description": "gdata"
+ },
+ "hashVerified": {
+ "description": "gdata",
+ "type": "boolean"
+ },
+ "diffDownloadResponse": {
+ "description": "gdata",
+ "$ref": "GdataDiffDownloadResponse"
+ },
"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"
- },
- "md5Hash": {
- "description": "gdata",
- "format": "byte",
- "type": "string"
- },
- "inline": {
- "description": "gdata",
- "format": "byte",
- "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": {
- "properties": {
- "fromFileName": {
- "description": "gdata",
- "type": "string"
- },
- "bestGuess": {
- "description": "gdata",
- "type": "string"
- },
- "fromUrlPath": {
- "description": "gdata",
- "type": "string"
- },
- "fromHeader": {
- "description": "gdata",
- "type": "string"
- },
- "fromBytes": {
- "description": "gdata",
- "type": "string"
- }
- },
- "id": "GdataContentTypeInfo",
- "description": "gdata",
- "type": "object"
- },
- "GdataDiffUploadResponse": {
- "description": "gdata",
- "type": "object",
- "properties": {
- "objectVersion": {
- "description": "gdata",
- "type": "string"
- },
- "originalObject": {
- "$ref": "GdataCompositeMedia",
- "description": "gdata"
- }
- },
- "id": "GdataDiffUploadResponse"
- },
- "Report": {
- "description": "A report's metadata including the URL from which the report itself can be\ndownloaded.",
- "type": "object",
- "properties": {
- "id": {
- "description": "The server-generated ID of the report.",
- "type": "string"
- },
- "jobExpireTime": {
- "description": "The date/time when the job this report belongs to will expire/expired.",
- "format": "google-datetime",
- "type": "string"
- },
- "endTime": {
- "description": "The end of the time period that the report instance covers. The value is\nexclusive.",
- "format": "google-datetime",
- "type": "string"
- },
- "downloadUrl": {
- "description": "The URL from which the report can be downloaded (max. 1000 characters).",
- "type": "string"
- },
- "startTime": {
- "description": "The start of the time period that the report instance covers. The value is\ninclusive.",
- "format": "google-datetime",
- "type": "string"
- },
- "createTime": {
- "description": "The date/time when this report was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "jobId": {
- "description": "The ID of the job that created this report.",
- "type": "string"
- }
- },
- "id": "Report"
- },
- "GdataDiffChecksumsResponse": {
- "description": "gdata",
- "type": "object",
- "properties": {
- "chunkSizeBytes": {
- "description": "gdata",
- "format": "int64",
- "type": "string"
- },
- "checksumsLocation": {
- "description": "gdata",
- "$ref": "GdataCompositeMedia"
- },
- "objectSizeBytes": {
- "description": "gdata",
- "format": "int64",
- "type": "string"
- },
- "objectLocation": {
- "description": "gdata",
- "$ref": "GdataCompositeMedia"
- },
- "objectVersion": {
- "description": "gdata",
- "type": "string"
- }
- },
- "id": "GdataDiffChecksumsResponse"
- },
- "GdataDownloadParameters": {
- "description": "gdata",
- "type": "object",
- "properties": {
- "ignoreRange": {
- "description": "gdata",
- "type": "boolean"
- },
- "allowGzipCompression": {
+ "isPotentialRetry": {
"description": "gdata",
"type": "boolean"
}
},
- "id": "GdataDownloadParameters"
- },
- "Job": {
- "properties": {
- "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"
- },
- "createTime": {
- "description": "The creation date/time of the job.",
- "format": "google-datetime",
- "type": "string"
- },
- "reportTypeId": {
- "description": "The type of reports this job creates. Corresponds to the ID of a\nReportType.",
- "type": "string"
- },
- "expireTime": {
- "description": "The date/time when this job will expire/expired. After a job expired, no\nnew reports are generated.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "The name of the job (max. 100 characters).",
- "type": "string"
- }
- },
- "id": "Job",
- "description": "A job creating reports of a specific type.",
- "type": "object"
+ "id": "GdataMedia"
}
},
"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://youtubereporting.googleapis.com/",
- "canonicalName": "YouTube Reporting",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/yt-analytics.readonly": {
- "description": "View YouTube Analytics reports for your YouTube content"
- },
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly": {
- "description": "View monetary and non-monetary YouTube Analytics reports for your YouTube content"
- }
- }
- }
- },
- "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/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "youtubereporting",
- "batchPath": "batch"
+ "protocol": "rest"
}
